View VM User Data

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView VM User Data
Description

View VM User Data as described in the Migrating Deployments use case

Allowed Role(s)WM_USER
MethodGET
URI

/job/service/nodeUserData/jobId 

cloudcenter-ccm-backend/api/job/service/nodeUserData/jobId 

Sample Request
curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/job/service/nodeUserData/559"
curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/job/service/nodeUserData/559"
Release

Introduced in CloudCenter 4.8.0

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • This API does not use v1 in the request URI.
  • If you provide the parent's Job ID, then the user data for the corresponding child jobs is displayed.
  • If you provide the child's Job ID, then the user data for that particular job is displayed.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: get.service.nodeUserData.jobId

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample

This request does not use /v1 or /v2 in the request call.

Response

[
   {
      "jobId":"559",
      "nodeIds":[
         "b5f49223-132d-4b9f-bab0-099268377d2b",
         "fd276f61-60f6-4f0b-a86b-90de83cf61a8"
      ],
      "userData":"{
         "jobId":"559",
         "numOfNICs":"1",
         "brokerVirtualHost":"/cliqr",
         "agentType":"worker0",
         "bootstrapConfig":"http://<HOST>:<PORT>/release-4.8.0.1/bundle/bootstrap.json",
         "agentAutoUpgradeURL":null,
         "ldapuser":"cliqruser",
         "gatewayAddress":"<HOST>:<PORT>",
         "agentBundleURL":"http://<HOST>:<PORT>/release-4.8.0.1/bundle/bootstrap-cliqr-worker.sh",
         "brokerClusterAddresses":"<HOST>:<PORT>",
         "nodeMetadataURL":"http://<HOST>:<PORT>/release-4.8.0.1/bundle/cloud-node-metadata.war"
      }"
   }
]

Request Attributes

jobId
  • DescriptionUnique, system-generated identifier for the job
  • Type: String

Response Attributes

jobId
  • DescriptionUnique, system-generated identifier for the job
  • Type: String

nodeIds
  • Description: Comma separated list of unique identifiers for the required tier.

    • If used in the request, provide multiple Node IDs for the same tier.

    • Use the correct Node ID for each tier in the application.

  • Type: String

userData
  • Description: Identifies the details of user data – If the parent jobId is provided, this API returns the user data for all the child tiers. If the child jobId is provided, this API returns the user data for that job. These details are retrieved from the CloudCenter platform and displayed in response to this API call. Treat the response as a JSON string.

    Copy the string that maps to the userData listed in the API response and provide the string to the agent upgrade script when prompted. Do not alter any value in the string. Some of these values are variables that may change based on your cloud usage.

  • Type: String of user data details that includes values and variable for multiple CloudCenter settings – only to be used as a JSON string.




  • No labels
© 2017-2019 Cisco Systems, Inc. All rights reserved