Apache CloudStack 4.20.0.0 Root Admin API Reference

updateAutoScaleVmProfile

Updates an existing autoscale vm profile.

Request parameters

Parameter NameDescriptionRequired
idthe ID of the autoscale vm profiletrue
autoscaleuseridthe ID of the user used to launch and destroy the VMsfalse
counterparamcounterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161false
customidan optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
expungevmgraceperiodthe time allowed for existing connections to get closed before a vm is destroyedfalse
fordisplayan optional field, whether to the display the profile to the end user or notfalse
otherdeployparamsparameters 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
serviceofferingidthe service offering of the auto deployed virtual machinefalse
templateidthe template of the auto deployed virtual machinefalse
userdataan 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 valuefalse
userdatadetailsused to specify the parameters values for the variables in userdata.false
userdataidthe ID of the userdatafalse

Response Tags

Response NameDescription
idthe autoscale vm profile ID
accountthe account owning the instance group
autoscaleuseridthe ID of the user used to launch and destroy the VMs
domainthe domain name of the vm profile
domainidthe domain ID of the vm profile
domainpathpath of the domain to which the vm profile belongs
expungevmgraceperiodthe time allowed for existing connections to get closed before a vm is destroyed
fordisplayis profile for display to the regular user
otherdeployparamsparameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine
projectthe project name of the vm profile
projectidthe project id vm profile
serviceofferingidthe service offering to be used while deploying a virtual machine
templateidthe template to be used while deploying a virtual machine
userdataBase64 encoded VM user data
userdatadetailslist of variables and values for the variables declared in userdata
userdataidthe id of userdata used for the VM
userdatanamethe name of userdata used for the VM
userdatapolicythe userdata override policy with the userdata provided while deploying VM
zoneidthe availability zone to be used while deploying a virtual machine