Apache CloudStack 4.18.0.0 Root Admin API Reference
createAutoScaleVmProfile
Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.
Request parameters
| Parameter Name | Description | Required |
| serviceofferingid | the service offering of the auto deployed virtual machine | true |
| templateid | the template of the auto deployed virtual machine | true |
| zoneid | availability zone for the auto deployed virtual machine | true |
| account | account that will own the autoscale VM profile | false |
| autoscaleuserid | the ID of the user used to launch and destroy the VMs | false |
| counterparam | counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161 | false |
| domainid | domain ID of the account owning a autoscale VM profile | false |
| expungevmgraceperiod | the time allowed for existing connections to get closed before a vm is expunged | false |
| fordisplay | an optional field, whether to the display the profile to the end user or not | false |
| otherdeployparams | parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 . Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". | false |
| projectid | an optional project for the autoscale VM profile | false |
| userdata | an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value | false |
Response Tags
| Response Name | Description |
| id | the autoscale vm profile ID |
| account | the account owning the instance group |
| autoscaleuserid | the ID of the user used to launch and destroy the VMs |
| domain | the domain name of the vm profile |
| domainid | the domain ID of the vm profile |
| expungevmgraceperiod | the time allowed for existing connections to get closed before a vm is destroyed |
| fordisplay | is profile for display to the regular user |
| otherdeployparams | parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine |
| project | the project name of the vm profile |
| projectid | the project id vm profile |
| serviceofferingid | the service offering to be used while deploying a virtual machine |
| templateid | the template to be used while deploying a virtual machine |
| userdata | Base 64 encoded VM user data |
| zoneid | the availability zone to be used while deploying a virtual machine |