// removed jquery ui css and js

Synchronize VM Cloud Information

Details

API Details
Name

Synchronize VM Cloud Information (Asynchronous API)

Description

Synchronize the latest VM information from the cloud.

MethodPUT
URIv1/jobs/jobId?action=synchronize_nodes
CloudCenter Release
  • CloudCenter 3.x and 4.x
  • Enhanced in CloudCenter 3.2.6.6. to include the additionalParameters attribute
NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: update.jobs.jobId
actionparam: action=synchronize_nodes

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs/920?action=synchronize_nodes" 

Response

The API suspends the VMs launched for this job:

{
    "id": "aaca0b9d-c427-41c8-942c-cb6b61a5b4d4",
    "resource": "https://10.10.30.10/v1/operationStatus/aaca0b9d-c427-41c8-942c-cb6b61a5b4d4",
    "perms": [],
    "msg": "Synchronizing job nodes' information."
} 


Use the Get Operation Status to view the current status and continue trying until you eventually receive the following response once the job nodes are successfully synchronized:

{
    "status": "SUCCESS",
    "msg": "Synchronization of job nodes' information is complete.",
    "resource": "https://10.10.30.10/v1/jobs/397/nodes",
    "additionalParameters": []
}

Request Attributes

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

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String
perms (click for additional details)
msg
  • Description: A response message reflecting the status of the operation.
  • Type: String
status
  • Description: Status of the operation. See Deployment and VM States for a list of all job operations.
  • Type: Enumeration

    EnumerationDescription
    SUBMITTEDThe operation has been submitted
    RUNNINGThe operation is currently in progress
    SUCCESSThe operation succeeded
    FAILThe operation failed
additionalParameters
  • Description: Parameters required to deploy the application
  • Type: Object