Apache CloudStack 4.18.0.0 Root Admin API Reference

linkUserDataToTemplate

Link or unlink a userdata to a template.

Request parameters

Parameter NameDescriptionRequired
isoidthe ID of the ISO for the virtual machinefalse
templateidthe ID of the template for the virtual machinefalse
userdataidthe ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISOfalse
userdatapolicyan optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverridefalse

Response Tags

Response NameDescription
idthe template ID
accountthe account name to which the template belongs
accountidthe account id to which the template belongs
bitsthe processor bit size
bootabletrue if the ISO is bootable, false otherwise
checksumchecksum of the template
childtemplatesif root disk template, then ids of the datas disk templates this template owns
createdthe date this template was created
crossZonestrue if the template is managed across all Zones, false otherwise
deployasisVMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template.
deployasisdetailsVMware only: additional key/value details tied with deploy-as-is template
detailsadditional key/value details tied with template
directdownloadKVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage
displaytextthe template display text
domainthe name of the domain to which the template belongs
domainidthe ID of the domain to which the template belongs
downloaddetailsLists the download progress of a template across all secondary storages
formatthe format of the template.
hostidthe ID of the secondary storage host for the template
hostnamethe name of the secondary storage host for the template
hypervisorthe hypervisor on which the template runs
iconBase64 string representation of the resource icon
isdynamicallyscalabletrue if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory
isextractabletrue if the template is extractable, false otherwise
isfeaturedtrue if this template is a featured template, false otherwise
ispublictrue if this template is a public template, false otherwise
isreadytrue if the template is ready to be deployed from, false otherwise.
namethe template name
ostypeidthe ID of the OS type for this template.
ostypenamethe name of the OS type for this template.
parenttemplateidif Datadisk template, then id of the root disk template this template belongs to
passwordenabledtrue if the reset password feature is enabled, false otherwise
physicalsizethe physical size of the template
projectthe project name of the template
projectidthe project id of the template
removedthe date this template was removed
requireshvmtrue if template requires HVM enabled, false otherwise
sizethe size of the template
sourcetemplateidthe template ID of the parent template if present
sshkeyenabledtrue if template is sshkey enabled, false otherwise
statusthe status of the template
templatetagthe tag of this template
templatetypethe type of the template
urlthe URL which the template/iso is registered from
userdataidthe id of userdata linked to this template
userdatanamethe name of userdata linked to this template
userdataparamslist of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
userdatapolicythe userdata override policy with the userdata provided while deploying VM
zoneidthe ID of the zone for this template
zonenamethe name of the zone for this template
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object