Import VM to CloudCenter

Details

API Details
Name

Import VM to CloudCenter

Description

A CloudCenter user who is the administrator and who is the cloud account owner can import a VM listed in the Unmanaged into the Managed category. See VM Management > Import to CloudCenter for additional context.

This API is similar to the Create Action Execution API, but explicitly added here for accountability.

MethodPOST
URIv1/actions/actionId/executions
CloudCenter ReleaseIntroduced in CloudCenter 4.8.0.
Notes
ESB Headeraction: create.actions.actionId.executions

Example

curl -k -X POST -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/actions/8/executions"


Request Body (Create Snapshot)

{
  "executionResources": [{
    "regionId": "5",
    "cloudAccountId": "5",
    "cloudResourceId": "UbuntuVM",
    "cloudResourceProperties": [{
      "name": "resourceGroup",
      "value": "testResourceGroup"
    }]
  }],
  "resourceType": "VIRTUAL_MACHINE",
  "executionSpecs": [],
  "acknowledgedByUser": "false",
  "acl": {
    "users": [{
      "id": 2,
      "perms": ["administration"]
    }],
    "userGroups": [],
    "tenantUsers": [{
      "id": "1",
      "perms": ["read"],
      "name": "Cisco Systems",
      "userId": "2",
      "shortName": null,
      "parentTenantId": null,
      "showAsShareAllUsersOnDilog": true
    }],
    "tenantAndSubtenantUsers": [],
    "ownerUserId": "2"
  }
}

Response

{
   "id":"1553",
   "resource":"https://<HOST>:<PORT>/v1/executions/1553",
   "executionResources":[
      {
         "cloudResourceId":"i-0ec935bc28e84d6ba",
         "id":0,
         "regionId":2,
         "cloudAccountId":6,
         "cloudResourceProperties":[

         ]
      }
   ],
   "resourceType":"VIRTUAL_MACHINE",
   "executionSpecs":[

   ],
   "acknowledgedByUser":false,
   "acl":null
}

Request Attributes

actionId
  • Description: The action ID of the import function.
  • Type: Long

executionSpecs
  • Description: The custom parameters required to execute the action – only required if you have the required permissions (editable and unlocked).
  • Type: Array of name-value pairs

    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    value
    • Description: Indicates the set value for this property
    • Type: Float

  • Example:

    "executionSpecs":[  
          {  
             "name":"snapshotName",
             "value":"demodocs"
          }
       ]
 executionResources

executionResources

 

Response Attributes

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

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String
 executionResources

executionResources

resourceType
  • Description: The data type for a CloudCenter Resource.

  • Type: String
    StringCategory
    CLOUD_FAMILYIdentifies this resource to be the cloud family
    CLOUD_TYPEIdentifies this resource to be the cloud region
    APP_NAMEIdentifies this resource to be the application
executionSpecs
  • Description: The custom parameters required to execute the action – only required if you have the required permissions (editable and unlocked).
  • Type: Array of name-value pairs

    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    value
    • Description: Indicates the set value for this property
    • Type: Float

  • Example:

    "executionSpecs":[  
          {  
             "name":"snapshotName",
             "value":"demodocs"
          }
       ]
acknowledgedByUser
  • Description: Identifies if the action is to be acknowledged by the user.
  • Type: Boolean
    • true = The action must be acknowledged.
    • false = Default. The action need not be acknowledged.
 acl

acl
  • Description: The users who are permitted to perform this action
  • Type: Sequence of user-specific details

    users
    • Description: The user that is assigned permission to view, modify, or manage this action. 
    • Type: Admin-defined string
    tenantUsers
    • Description: The tenant that is assigned permission to view, modify, or manage this action. 
    • Type: Admin-defined string
    userGroups
    • Description: The user group that is assigned permission to view, modify, or manage this action. 
    • Type: Admin-defined string
     ownerUserId 
    • DescriptionUnique, system-generated identifier for the owner of the tenant to which this service owner belongs
    • Type: String

 

 

  • No labels