Deployment Profile API

Contents

/deploymentprofile/{id} (GET)

Description

Gets details of an existing deployment profile.

URL structure

https?//smart.cloud.com/v0/deploymentprofile/{id}?access_token=<valid access token>

URL example

https: //smart.cloud.com/v0/deploymentprofile/2927?access_token=DOTqOd51i78K8gN61bLspZIBO

Method

GET

Response

Sample response:

 {
   "companyId":0,
   "extraAttrs":{

   },
   "deploymentProfileId":2927,
   "deploymentProfileName":"deployProfile1446613878199",
   "description":"",
   "processId":58487,
   "processVersion":1,
   "matching":false,
   "profileDetails":[
      {
         "companyId":0,
         "extraAttrs":{

         },
         "deploymentProfileId":2927,
         "attributeName":"LAUNCH_SCRIPT_aba3ae09-046f-4c41-97ed-25a396867114",
         "attributeValue":"{\"taskName\":\"Server\",\"code\":\"LAUNCH_SCRIPT_aba3ae09-046f-4c41-97ed-25a396867114\",\"description\":\"\",\"isAsync\":false,\"timeout\":10000,\"inputs\":[{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"instanceCount\",\"propertyValue\":\"1\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false}],\"properties\":[{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"config\",\"propertyValue\":\"{\\\"imageId\\\":\\\"ami-50c34950\\\",\\\"provider_id\\\":\\\"818\\\",\\\"region\\\":\\\"ec2.ap-northeast-1.amazonaws.com\\\",\\\"table-id-1_length\\\":\\\"10\\\",\\\"table-id-2_length\\\":\\\"10\\\",\\\"cidr\\\":\\\"\\\",\\\"name\\\":\\\"\\\",\\\"public_subnet\\\":\\\"\\\",\\\"public_subnet_name\\\":\\\"Public subnet\\\",\\\"private_subnet\\\":\\\"\\\",\\\"private_subnet_name\\\":\\\"Private subnet\\\",\\\"nat_inst_type\\\":\\\"t2.micro\\\",\\\"instance_name\\\":\\\"Munis\\\",\\\"instance_name_suffix\\\":\\\"1\\\",\\\"auto_set_name_suffix\\\":\\\"1\\\",\\\"launch-into\\\":\\\"vpc-a57ec6c0\\\",\\\"subnet\\\":\\\"subnet-0ba00b52\\\",\\\"instanceType\\\":\\\"t1.micro\\\",\\\"root_dev_size\\\":\\\"50\\\",\\\"ebs_root_devname\\\":\\\"/dev/sda1\\\",\\\"new_key_name\\\":\\\"\\\",\\\"image-creds-choose\\\":\\\"on\\\",\\\"keyPair\\\":\\\"clmbuild_id_rsa\\\",\\\"global_private_key\\\":\\\"private_key_f33858156a64534a05afaa704fbb09a1\\\",\\\"iframe_private_key\\\":\\\"\\\",\\\"username\\\":\\\"\\\",\\\"password\\\":\\\"\\\",\\\"securityGroup\\\":\\\"sg-8bdc8cee\\\",\\\"temp-security-rule-port\\\":\\\"-1\\\",\\\"vpcid\\\":\\\"vpc-a57ec6c0\\\",\\\"ami_name\\\":\\\"Windows_Server-2012-RTM-English-64Bit-SQL_2012_SP1_Web-2015.09.09\\\",\\\"elastic_ip\\\":[\\\"\\\"],\\\"instanceCount\\\":\\\"1\\\",\\\"find_nat_instanc_id\\\":\\\"i-42bbd0e0\\\",\\\"ui\\\":\\\"<h3 class=\\\\\\\"ui header\\\\\\\">Review VM configuration</h3><div id=\\\\\\\"review\\\\\\\" class=\\\\\\\"sx-clear sx-1-cols sx-cols sx-table-layout\\\\\\\"><ul class=\\\\\\\"sx-col\\\\\\\"><li><strong>VM Name:</strong><span>Munis</span></li><li><strong>Region: </strong> <span>ec2.ap-northeast-1.amazonaws.com</span></li><li><strong>AMI: </strong> <span>Windows_Server-2012-RTM-English-64Bit-SQL_2012_SP1_Web-2015.09.09</span></li><li><strong>Root Volume Size: </strong> <span>50 GB</span></li><li class=\\\\\\\"count\\\\\\\"><strong>Number of Instances: </strong> <span>1</span></li><li><strong>Instance Type: </strong> <span>t1.micro</span></li><li><strong>Key Pair: </strong> <span>clmbuild_id_rsa</span></li><li><strong>VPC : </strong> <span>vpc-a57ec6c0 , Vinay-Vpc-DonotUse</span></li><li><strong>Subnet: </strong> <span>subnet-0ba00b52 , Private subnet</span></li><li><strong>Security Group: </strong> <span>sg-8bdc8cee</span></li></ul></div>\\\",\\\"isLogonInfoEncrypted\\\":1,\\\"code\\\":\\\"ec2\\\"}\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"configDataType\",\"propertyValue\":\"json\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"int\",\"propertyKey\":\"provider_id\",\"propertyValue\":\"818\",\"propValueArr\":[],\"required\":true,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"provider_name\",\"propertyValue\":\"ec2\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"recSpec\",\"propertyValue\":\"\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"agentInstallation\",\"propertyValue\":\"optional\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false}],\"stepCode\":\"LAUNCH_STEP\",\"className\":\"com.centro.task.step.MutatedLaunchStep\",\"runType\":\"remote\",\"onFailure\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"exit\",\"noOfRetries\":1,\"sleepMsBetweenRetries\":0},\"onTimeout\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"continue\",\"noOfRetries\":0,\"sleepMsBetweenRetries\":0},\"args\":[],\"target\":[],\"serverGroup\":[],\"preSegment\":\"\",\"postSegment\":\"\",\"cloudBaseUrl\":\"https://manage-mon.citrix.com\",\"monBaseUrl\":\"https://manage-mon.citrix.com\",\"taskId\":0,\"version\":null,\"type\":null,\"shared\":null,\"extraAttrs\":{},\"isMutatedLaunchStep\":true,\"process\":{\"code\":\"PROCESS_4c79999b-68c9-4ec1-87ee-761437bb4493\",\"processName\":\"DB1\",\"processType\":null},\"stepFacet\":[],\"processFacet\":[],\"displayName\":\"1. Server\",\"createNewVM\":\"Y\"}"
      },
      {
         "companyId":0,
         "extraAttrs":{

         },
         "deploymentProfileId":2927,
         "attributeName":"SERVER_LIST",
         "attributeValue":"818"
      }
   ]
}       

Back to top

/deploymentprofile/

Description

Creates a deployment profile.

URL structure

https?//smart.cloud.com/v0/deploymentprofile?access_token=<valid access token>

URL example

https: //smart.cloud.com/v0/deploymentprofile?access_token=DOTqOd51i78K8gN61bLspZIBO&processIdStr=58487&deploymentProfileName=deployProfile1446613878199&processVersionStr=1

Method

POST

Parameters

Name Required or Optional
processIDStr Required
processVersionStr Required
deploymentProfileName Required
description Optional
providerIdListStr Optional
profileDetailsStr Required, in API body

 

  • processIDStr (required)
  • processVersionStr (required)
  • deploymentProfileName (required)
  • description (optional)
  • providerIdListStr (optional)
  • profileDetailsStr (required in API body)

Response

JSON payload

Sample response:

{  
   "companyId":0,
   "extraAttrs":{  

   },
   "deploymentProfileId":2927,
   "deploymentProfileName":"deployProfile1446613878199",
   "description":"",
   "processId":58487,
   "processVersion":1,
   "matching":false,
   "profileDetails":[  
      {  
         "companyId":0,
         "extraAttrs":{  

         },
         "deploymentProfileId":2927,
         "attributeName":"LAUNCH_SCRIPT_aba3ae09-046f-4c41-97ed-25a396867114",
         "attributeValue":"{\"taskName\":\"Server\",\"code\":\"LAUNCH_SCRIPT_aba3ae09-046f-4c41-97ed-25a396867114\",\"description\":\"\",\"isAsync\":false,\"timeout\":10000,\"inputs\":[{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"instanceCount\",\"propertyValue\":\"1\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false}],\"properties\":[{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"config\",\"propertyValue\":\"{\\\"imageId\\\":\\\"ami-50c34950\\\",\\\"provider_id\\\":\\\"818\\\",\\\"region\\\":\\\"ec2.ap-northeast-1.amazonaws.com\\\",\\\"table-id-1_length\\\":\\\"10\\\",\\\"table-id-2_length\\\":\\\"10\\\",\\\"cidr\\\":\\\"\\\",\\\"name\\\":\\\"\\\",\\\"public_subnet\\\":\\\"\\\",\\\"public_subnet_name\\\":\\\"Public subnet\\\",\\\"private_subnet\\\":\\\"\\\",\\\"private_subnet_name\\\":\\\"Private subnet\\\",\\\"nat_inst_type\\\":\\\"t2.micro\\\",\\\"instance_name\\\":\\\"Munis\\\",\\\"instance_name_suffix\\\":\\\"1\\\",\\\"auto_set_name_suffix\\\":\\\"1\\\",\\\"launch-into\\\":\\\"vpc-a57ec6c0\\\",\\\"subnet\\\":\\\"subnet-0ba00b52\\\",\\\"instanceType\\\":\\\"t1.micro\\\",\\\"root_dev_size\\\":\\\"50\\\",\\\"ebs_root_devname\\\":\\\"/dev/sda1\\\",\\\"new_key_name\\\":\\\"\\\",\\\"image-creds-choose\\\":\\\"on\\\",\\\"keyPair\\\":\\\"clmbuild_id_rsa\\\",\\\"global_private_key\\\":\\\"private_key_f33858156a64534a05afaa704fbb09a1\\\",\\\"iframe_private_key\\\":\\\"\\\",\\\"username\\\":\\\"\\\",\\\"password\\\":\\\"\\\",\\\"securityGroup\\\":\\\"sg-8bdc8cee\\\",\\\"temp-security-rule-port\\\":\\\"-1\\\",\\\"vpcid\\\":\\\"vpc-a57ec6c0\\\",\\\"ami_name\\\":\\\"Windows_Server-2012-RTM-English-64Bit-SQL_2012_SP1_Web-2015.09.09\\\",\\\"elastic_ip\\\":[\\\"\\\"],\\\"instanceCount\\\":\\\"1\\\",\\\"find_nat_instanc_id\\\":\\\"i-42bbd0e0\\\",\\\"ui\\\":\\\"<h3 class=\\\\\\\"ui header\\\\\\\">Review VM configuration</h3><div id=\\\\\\\"review\\\\\\\" class=\\\\\\\"sx-clear sx-1-cols sx-cols sx-table-layout\\\\\\\"><ul class=\\\\\\\"sx-col\\\\\\\"><li><strong>VM Name:</strong><span>Munis</span></li><li><strong>Region: </strong> <span>ec2.ap-northeast-1.amazonaws.com</span></li><li><strong>AMI: </strong> <span>Windows_Server-2012-RTM-English-64Bit-SQL_2012_SP1_Web-2015.09.09</span></li><li><strong>Root Volume Size: </strong> <span>50 GB</span></li><li class=\\\\\\\"count\\\\\\\"><strong>Number of Instances: </strong> <span>1</span></li><li><strong>Instance Type: </strong> <span>t1.micro</span></li><li><strong>Key Pair: </strong> <span>clmbuild_id_rsa</span></li><li><strong>VPC : </strong> <span>vpc-a57ec6c0 , Vinay-Vpc-DonotUse</span></li><li><strong>Subnet: </strong> <span>subnet-0ba00b52 , Private subnet</span></li><li><strong>Security Group: </strong> <span>sg-8bdc8cee</span></li></ul></div>\\\",\\\"isLogonInfoEncrypted\\\":1,\\\"code\\\":\\\"ec2\\\"}\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"configDataType\",\"propertyValue\":\"json\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"int\",\"propertyKey\":\"provider_id\",\"propertyValue\":\"818\",\"propValueArr\":[],\"required\":true,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"provider_name\",\"propertyValue\":\"ec2\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"recSpec\",\"propertyValue\":\"\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"agentInstallation\",\"propertyValue\":\"optional\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false}],\"stepCode\":\"LAUNCH_STEP\",\"className\":\"com.centro.task.step.MutatedLaunchStep\",\"runType\":\"remote\",\"onFailure\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"exit\",\"noOfRetries\":1,\"sleepMsBetweenRetries\":0},\"onTimeout\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"continue\",\"noOfRetries\":0,\"sleepMsBetweenRetries\":0},\"args\":[],\"target\":[],\"serverGroup\":[],\"preSegment\":\"\",\"postSegment\":\"\",\"cloudBaseUrl\":\"https://manage-mon.citrix.com\",\"monBaseUrl\":\"https://manage-mon.citrix.com\",\"taskId\":0,\"version\":null,\"type\":null,\"shared\":null,\"extraAttrs\":{},\"isMutatedLaunchStep\":true,\"process\":{\"code\":\"PROCESS_4c79999b-68c9-4ec1-87ee-761437bb4493\",\"processName\":\"DB1\",\"processType\":null},\"stepFacet\":[],\"processFacet\":[],\"displayName\":\"1. Server\",\"createNewVM\":\"Y\"}"
      },
      {  
         "companyId":0,
         "extraAttrs":{  

         },
         "deploymentProfileId":2927,
         "attributeName":"SERVER_LIST",
         "attributeValue":"818"
      }
   ]
}

Back to top

/deploymentprofile/{id} (POST)

Description

Edits or modifies an existing deployment profile.

URL structure

https?//smart.cloud.com/v0/deploymentprofile/{id}?access_token=<valid access token>

URL example

https: //smart.cloud.com/v0/deploymentprofile/2921?access_token=DOTqOd51i78K8gN61bLspZIBO&processIdStr=58483&processVersionStr=1&deploymentProfileName=EditProfileName

Method: POST

Parameters

Name Required or Optional
processIDStr Required
processVersionStr Required
deploymentProfileName Required
description Optional
providerIdListStr Optional
profileDetailsStr Required in API body

Response

JSON payload

Sample response:

{  
   "companyId":0,
   "extraAttrs":{  

   },
   "deploymentProfileId":3159,
   "deploymentProfileName":"Xenserver1",
   "description":"",
   "processId":70601,
   "processVersion":2,
   "matching":false,
   "profileDetails":[  
      {  
         "companyId":0,
         "extraAttrs":{  

         },
         "deploymentProfileId":3159,
         "attributeName":"LAUNCH_SCRIPT_e7edf453-089d-47aa-8d94-ebc50d595f7e",
         "attributeValue":"{\"companyId\":0,\"extraAttrs\":{},\"taskId\":0,\"processId\":0,\"sequenceNumber\":0,\"taskName\":\"Server\",\"description\":\"\",\"className\":\"com.centro.task.step.MutatedLaunchStep\",\"nextTaskId\":0,\"parentTaskId\":0,\"runAsyncFlag\":0,\"continueOnFailure\":0,\"taskProperties\":[],\"taskParameters\":[],\"rootProcessId\":0,\"code\":\"LAUNCH_SCRIPT_e7edf453-089d-47aa-8d94-ebc50d595f7e\",\"runAsync\":false,\"timeout\":10000,\"stepCode\":\"LAUNCH_STEP\",\"runType\":\"remote\",\"inputs\":[{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"instanceCount\",\"propertyValue\":\"1\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false}],\"outputs\":[],\"properties\":[{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"config\",\"propertyValue\":\"{\\\"provider_id\\\":\\\"735\\\",\\\"instanceCount\\\":\\\"1\\\",\\\"params\\\":{\\\"name\\\":\\\"TestVM\\\",\\\"cpu\\\":\\\"2\\\",\\\"core_per_cpu\\\":\\\"1\\\",\\\"memory\\\":2147483648,\\\"instance_name_suffix\\\":\\\"1\\\",\\\"auto_set_name_suffix\\\":true,\\\"template_types\\\":\\\"custom\\\",\\\"tpl_id\\\":\\\"OpaqueRef:6a65dc0d-334b-cade-da2d-ccd2f8df50b5\\\",\\\"home_server\\\":\\\"OpaqueRef:b4fe71a5-2bef-9020-56ff-03cb2bd96044\\\",\\\"fast_clone\\\":true,\\\"tpl_distro\\\":\\\"windows\\\",\\\"boot_params\\\":\\\"\\\",\\\"agent\\\":{\\\"username\\\":\\\"administrator\\\",\\\"password\\\":\\\"2SpM1ZwSOh4vPew6T36lzDX3UwhJ1v7tRc4etc4eLdjwrIzmkqAb5jYjumLbp/GK2KbwUlAQusXp8YEqY9BLmg==\\\"},\\\"nics\\\":[{\\\"MTU\\\":\\\"1500\\\",\\\"qos_algorithm_type\\\":\\\"\\\",\\\"qos_algorithm_params\\\":[],\\\"network\\\":\\\"OpaqueRef:2185a5a8-e0a4-eb37-0e36-b93faa116f24\\\",\\\"MAC_autogenerated\\\":true,\\\"MAC\\\":\\\"\\\",\\\"network_name\\\":\\\"Network 0\\\"}],\\\"disks\\\":[{\\\"name\\\":\\\"default disk 0\\\",\\\"virtual_size\\\":\\\"68719476736\\\",\\\"sr_ref\\\":\\\"OpaqueRef:c45351ce-ccbf-df46-5a3c-04452293dd10\\\",\\\"is_new\\\":false}],\\\"install_agent\\\":\\\"1\\\",\\\"copy_sr\\\":\\\"OpaqueRef:c45351ce-ccbf-df46-5a3c-04452293dd10\\\"},\\\"ui\\\":\\\"<ul class=\\\\\\\"sx-col\\\\\\\"><li><strong>Virtual Machine Name:</strong><span>TestVM</span></li><li class=\\\\\\\"count\\\\\\\"><strong>Instance Count:</strong><span>1</span></li><li><strong>Template Name: </strong><span>nfs-windows-2012-sysprep</span></li><li><strong>Home Server: </strong><span>SCX-XS02</span></li><li><strong>Num of CPU:</strong><span>2</span></li><li><strong>Topology: </strong><span>2 socket(s) with 1 core(s) per socket</span></li><li><strong>Memory Size:</strong><span>2048 MB </span></li><li><strong>Disk: </strong><span>default disk 0:64.00 GB<br></span></li><li><strong>Network: </strong><span>Auto generated MAC Address:Network 0<br></span></li></ul>\\\",\\\"isLogonInfoEncrypted\\\":1,\\\"code\\\":\\\"xenserver\\\"}\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"configDataType\",\"propertyValue\":\"json\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"int\",\"propertyKey\":\"provider_id\",\"propertyValue\":\"735\",\"propValueArr\":[],\"required\":true,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"provider_name\",\"propertyValue\":\"xenserver\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"recSpec\",\"propertyValue\":\"\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"agentInstallation\",\"propertyValue\":\"optional\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false}],\"target\":[],\"serverGroup\":[],\"excludeTarget\":[],\"onTimeout\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"continue\",\"noOfRetries\":0,\"sleepMsBetweenRetries\":0},\"onFailure\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"exit\",\"noOfRetries\":1,\"sleepMsBetweenRetries\":0},\"sequenceNext\":\"SHUTDOWN_PROCESS_8d688006-46f3-43cd-b1c5-b3b98b695595\",\"tagList\":[],\"cancelFlag\":true,\"outputFlag\":true,\"preSegment\":\"\",\"runAsUsernameReferenced\":false,\"runAsPasswordReferenced\":false,\"credentialId\":0,\"postSegment\":\"\",\"process\":{\"code\":\"PROCESS_3a41c71d-12a5-4a5e-a901-d16b1549ba3b\",\"processName\":\"testLaunch\",\"processType\":null},\"stepFacet\":[],\"processFacet\":[],\"displayName\":\"1. Server\",\"createNewVM\":\"Y\"}"
      },
      {  
         "companyId":0,
         "extraAttrs":{  

         },
         "deploymentProfileId":3159,
         "attributeName":"SERVER_LIST",
         "attributeValue":"735"
      },
      {  
         "companyId":0,
         "extraAttrs":{  

         },
         "deploymentProfileId":3159,
         "attributeName":"TERMINATE_3aee4ddb-4ae2-4a2d-9ee9-ce10cffa5ed8",
         "attributeValue":"{\"companyId\":0,\"extraAttrs\":{},\"taskId\":0,\"processId\":0,\"sequenceNumber\":0,\"taskName\":\"Terminate Machine\",\"description\":\"\",\"className\":\"com.centro.task.step.TerminateMachineStep\",\"nextTaskId\":0,\"parentTaskId\":0,\"runAsyncFlag\":0,\"continueOnFailure\":0,\"taskProperties\":[],\"taskParameters\":[],\"rootProcessId\":0,\"code\":\"TERMINATE_3aee4ddb-4ae2-4a2d-9ee9-ce10cffa5ed8\",\"runAsync\":false,\"timeout\":10000,\"stepCode\":\"TERMINATE_STEP\",\"runType\":\"remote\",\"inputs\":[],\"outputs\":[],\"properties\":[{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"config\",\"propertyValue\":\"[{\\\"step_id\\\":\\\"\\\",\\\"provider_id\\\":\\\"\\\",\\\"step\\\":\\\"\\\",\\\"instanceid\\\":\\\"\\\",\\\"machine_num\\\":\\\"\\\",\\\"region\\\":\\\"\\\",\\\"stepCode\\\":\\\"\\\"}]\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"configDataType\",\"propertyValue\":\"json\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false}],\"target\":[],\"serverGroup\":[],\"excludeTarget\":[],\"onTimeout\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"continue\",\"noOfRetries\":0,\"sleepMsBetweenRetries\":0},\"onFailure\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"exit\",\"noOfRetries\":0,\"sleepMsBetweenRetries\":0},\"tagList\":[],\"cancelFlag\":true,\"outputFlag\":true,\"preSegment\":\"\",\"runAsUsernameReferenced\":false,\"runAsPasswordReferenced\":false,\"credentialId\":0,\"postSegment\":\"\",\"displayName\":\"Terminate Machine\"}"
      }
   ]
}

Back to top

/deploymentprofile/{id} (DELETE)

Description

Deletes an existing deployment profile.

URL structure

https?//smart.cloud.com/v0/deploymentprofile/{id}?access_token=<valid access token>

URL example

https: //smart.cloud.com/v0/deploymentprofile/2922?access_token=DOTqOd51i78K8gN61bLspZIBO

Method

DELETE

Response

JSON payload

Sample response:

true 

Back to top

/deploymentprofile/{id}/deploy

Description

Deploys a blueprint from a deployment profile.

URL structure

https? //smart.cloud.com/v0/deploymentprofile/{id}/deploy?access_token=<valid access token>

URL example

https: //smart.cloud.com/v0/deploymentprofile/2907/deploy?access_token=DOTqOd51i78K8gN61bLspZIBO&processId=57613&name=9

Method

POST

Parameters

Name Required or Optional
processId Required
name Required

Response

JSON payload

 Sample response:

{  
   "processInstanceId":23529,
   "runbean":{  
      "companyId":10200,
      "role":"Admin",
      "user":"10009",
      "extraAttrs":{  
         "tags":"source:TestNegativeBP"
      },
      "name":"9",
      "scriptId":0,
      "scriptArgs":[  

      ],
      "targets":[  

      ],
      "scheduleType":12,
      "startTime":1446614529127,
      "endTime":86560703999127,
      "repeatCount":1,
      "repeatInterval":1,
      "offset":0,
      "jobId":27737,
      "taskParameters":[  

      ],
      "scriptType":"PROCESS",
      "serverGroups":[  

      ],
      "serverGroupExpr":"",
      "excludeTargets":[  

      ],
      "jobType":"ProcessJob",
      "jobParams":{  
         "instanceVersion":"1",
         "instanceLocation":"10200/10009/1446614513631/"
      },
      "credentialId":0,
      "parentJobId":0,
      "runNow":true,
      "trigger":{  
         "name":"56829",
         "jobName":"27737",
         "organizationId":10200,
         "roleName":"Admin",
         "userName":"10009",
         "startTime":1446614529127,
         "endTime":86560703999127,
         "repeatCount":1,
         "repeatInterval":60000,
         "timesTriggered":1,
         "prevFireTime":1446614529127,
         "volatile":false
      },
      "jobDetail":{  
         "name":"9",
         "jobClass":"com.centro.sched.ProcessJob",
         "jobDataMap":{  
            "data":{  
               "instanceVersion":"1",
               "instanceLocation":"10200/10009/1446614513631/"
            }
         },
         "projectGroup":"23529",
         "targetGroup":"80675",
         "schedule":"56829",
         "jobId":27737,
         "parentJobId":0,
         "role":"Admin",
         "user":"10009",
         "organizationid":10200,
         "durable":false,
         "stateful":false,
         "volatile":false
      }
   },
   "processid":57613,
   "processName":"9",
   "jobdetailid":27737
}

Back to top

/deploymentprofile/list

Description

Gets a list of deployment profiles for a blueprint.

URL structure

https: //smart.cloud.com/v0/deploymentprofile/list?access_token=<access-token>&processId=<process-ID>&processVersion=<process-version>

URL example

https: //smart.cloud.com/v0/deploymentprofile/list?access_token=DOTqOd51i78K8gN61bLspZIBO&processId=58486&processVersion=1

Method

POST

Parameters

Name Required or Optional
processId Required
processVersion Required
providerIdList Optional

Response

JSON payload

Sample response:

[  
   {  
      "companyId":0,
      "extraAttrs":{  

      },
      "deploymentProfileId":3139,
      "deploymentProfileName":"Xenserver",
      "description":"Xenserver",
      "processId":70601,
      "processVersion":1,
      "matching":false,
      "profileDetails":[  
         {  
            "companyId":0,
            "extraAttrs":{  

            },
            "deploymentProfileId":3139,
            "attributeName":"LAUNCH_SCRIPT_e7edf453-089d-47aa-8d94-ebc50d595f7e",
            "attributeValue":"{\"companyId\":0,\"extraAttrs\":{},\"taskId\":0,\"processId\":0,\"sequenceNumber\":0,\"taskName\":\"Server\",\"description\":\"\",\"className\":\"com.centro.task.step.MutatedLaunchStep\",\"nextTaskId\":0,\"parentTaskId\":0,\"runAsyncFlag\":0,\"continueOnFailure\":0,\"taskProperties\":[],\"taskParameters\":[],\"rootProcessId\":0,\"code\":\"LAUNCH_SCRIPT_e7edf453-089d-47aa-8d94-ebc50d595f7e\",\"runAsync\":false,\"timeout\":10000,\"stepCode\":\"LAUNCH_STEP\",\"runType\":\"remote\",\"inputs\":[{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"instanceCount\",\"propertyValue\":\"1\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false}],\"outputs\":[],\"properties\":[{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"config\",\"propertyValue\":\"{\\\"provider_id\\\":\\\"735\\\",\\\"instanceCount\\\":\\\"1\\\",\\\"params\\\":{\\\"name\\\":\\\"TestVM\\\",\\\"cpu\\\":\\\"2\\\",\\\"core_per_cpu\\\":\\\"1\\\",\\\"memory\\\":2147483648,\\\"instance_name_suffix\\\":\\\"1\\\",\\\"auto_set_name_suffix\\\":true,\\\"template_types\\\":\\\"custom\\\",\\\"tpl_id\\\":\\\"OpaqueRef:6a65dc0d-334b-cade-da2d-ccd2f8df50b5\\\",\\\"home_server\\\":\\\"OpaqueRef:b4fe71a5-2bef-9020-56ff-03cb2bd96044\\\",\\\"fast_clone\\\":true,\\\"tpl_distro\\\":\\\"windows\\\",\\\"boot_params\\\":\\\"\\\",\\\"agent\\\":{\\\"username\\\":\\\"administrator\\\",\\\"password\\\":\\\"2SpM1ZwSOh4vPew6T36lzDX3UwhJ1v7tRc4etc4eLdjwrIzmkqAb5jYjumLbp/GK2KbwUlAQusXp8YEqY9BLmg==\\\"},\\\"nics\\\":[{\\\"MTU\\\":\\\"1500\\\",\\\"qos_algorithm_type\\\":\\\"\\\",\\\"qos_algorithm_params\\\":[],\\\"network\\\":\\\"OpaqueRef:2185a5a8-e0a4-eb37-0e36-b93faa116f24\\\",\\\"MAC_autogenerated\\\":true,\\\"MAC\\\":\\\"\\\",\\\"network_name\\\":\\\"Network 0\\\"}],\\\"disks\\\":[{\\\"name\\\":\\\"default disk 0\\\",\\\"virtual_size\\\":\\\"68719476736\\\",\\\"sr_ref\\\":\\\"OpaqueRef:c45351ce-ccbf-df46-5a3c-04452293dd10\\\",\\\"is_new\\\":false}],\\\"install_agent\\\":\\\"1\\\",\\\"copy_sr\\\":\\\"OpaqueRef:c45351ce-ccbf-df46-5a3c-04452293dd10\\\"},\\\"ui\\\":\\\"<ul class=\\\\\\\"sx-col\\\\\\\"><li><strong>Virtual Machine Name:</strong><span>TestVM</span></li><li class=\\\\\\\"count\\\\\\\"><strong>Instance Count:</strong><span>1</span></li><li><strong>Template Name: </strong><span>nfs-windows-2012-sysprep</span></li><li><strong>Home Server: </strong><span>SCX-XS02</span></li><li><strong>Num of CPU:</strong><span>2</span></li><li><strong>Topology: </strong><span>2 socket(s) with 1 core(s) per socket</span></li><li><strong>Memory Size:</strong><span>2048 MB </span></li><li><strong>Disk: </strong><span>default disk 0:64.00 GB<br></span></li><li><strong>Network: </strong><span>Auto generated MAC Address:Network 0<br></span></li></ul>\\\",\\\"isLogonInfoEncrypted\\\":1,\\\"code\\\":\\\"xenserver\\\"}\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"configDataType\",\"propertyValue\":\"json\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"int\",\"propertyKey\":\"provider_id\",\"propertyValue\":\"735\",\"propValueArr\":[],\"required\":true,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"provider_name\",\"propertyValue\":\"xenserver\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"recSpec\",\"propertyValue\":\"\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"agentInstallation\",\"propertyValue\":\"optional\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false}],\"target\":[],\"serverGroup\":[],\"excludeTarget\":[],\"onTimeout\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"continue\",\"noOfRetries\":0,\"sleepMsBetweenRetries\":0},\"onFailure\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"exit\",\"noOfRetries\":1,\"sleepMsBetweenRetries\":0},\"sequenceNext\":\"SHUTDOWN_PROCESS_8d688006-46f3-43cd-b1c5-b3b98b695595\",\"tagList\":[],\"cancelFlag\":true,\"outputFlag\":true,\"preSegment\":\"\",\"runAsUsernameReferenced\":false,\"runAsPasswordReferenced\":false,\"credentialId\":0,\"postSegment\":\"\",\"process\":{\"code\":\"PROCESS_3a41c71d-12a5-4a5e-a901-d16b1549ba3b\",\"processName\":\"testLaunch\",\"processType\":null},\"stepFacet\":[],\"processFacet\":[],\"displayName\":\"1. Server\",\"createNewVM\":\"Y\"}"
         },
         {  
            "companyId":0,
            "extraAttrs":{  

            },
            "deploymentProfileId":3139,
            "attributeName":"SERVER_LIST",
            "attributeValue":"735"
         },
         {  
            "companyId":0,
            "extraAttrs":{  

            },
            "deploymentProfileId":3139,
            "attributeName":"TERMINATE_3aee4ddb-4ae2-4a2d-9ee9-ce10cffa5ed8",
            "attributeValue":"{\"companyId\":0,\"extraAttrs\":{},\"taskId\":0,\"processId\":0,\"sequenceNumber\":0,\"taskName\":\"Terminate Machine\",\"description\":\"\",\"className\":\"com.centro.task.step.TerminateMachineStep\",\"nextTaskId\":0,\"parentTaskId\":0,\"runAsyncFlag\":0,\"continueOnFailure\":0,\"taskProperties\":[],\"taskParameters\":[],\"rootProcessId\":0,\"code\":\"TERMINATE_3aee4ddb-4ae2-4a2d-9ee9-ce10cffa5ed8\",\"runAsync\":false,\"timeout\":10000,\"stepCode\":\"TERMINATE_STEP\",\"runType\":\"remote\",\"inputs\":[],\"outputs\":[],\"properties\":[{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"config\",\"propertyValue\":\"[{\\\"step_id\\\":\\\"\\\",\\\"provider_id\\\":\\\"\\\",\\\"step\\\":\\\"\\\",\\\"instanceid\\\":\\\"\\\",\\\"machine_num\\\":\\\"\\\",\\\"region\\\":\\\"\\\",\\\"stepCode\\\":\\\"\\\"}]\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false},{\"companyId\":0,\"extraAttrs\":{},\"processId\":0,\"type\":\"string\",\"propertyKey\":\"configDataType\",\"propertyValue\":\"json\",\"propValueArr\":[],\"required\":false,\"version\":1,\"editable\":true,\"visible\":true,\"deleted\":false}],\"target\":[],\"serverGroup\":[],\"excludeTarget\":[],\"onTimeout\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"continue\",\"noOfRetries\":0,\"sleepMsBetweenRetries\":0},\"onFailure\":{\"companyId\":0,\"extraAttrs\":{},\"action\":\"exit\",\"noOfRetries\":0,\"sleepMsBetweenRetries\":0},\"tagList\":[],\"cancelFlag\":true,\"outputFlag\":true,\"preSegment\":\"\",\"runAsUsernameReferenced\":false,\"runAsPasswordReferenced\":false,\"credentialId\":0,\"postSegment\":\"\",\"displayName\":\"Terminate Machine\"}"
         }
      ]
   }
]

Back to top

0 Comments