Apache CloudStack 4.20.0.0 Root Admin API Reference
updateAutoScaleVmProfile
Updates an existing autoscale vm profile.
Request parameters
Parameter Name | Description | Required |
id | the ID of the autoscale vm profile | true |
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 |
customid | an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only | false |
expungevmgraceperiod | the time allowed for existing connections to get closed before a vm is destroyed | 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 |
serviceofferingid | the service offering of the auto deployed virtual machine | false |
templateid | the template of the auto deployed virtual machine | 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 |
userdatadetails | used to specify the parameters values for the variables in userdata. | false |
userdataid | the ID of the userdata | 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 |
domainpath | path of the domain to which the vm profile belongs |
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 | Base64 encoded VM user data |
userdatadetails | list of variables and values for the variables declared in userdata |
userdataid | the id of userdata used for the VM |
userdataname | the name of userdata used for the VM |
userdatapolicy | the userdata override policy with the userdata provided while deploying VM |
zoneid | the availability zone to be used while deploying a virtual machine |