Apache CloudStack 4.23.0.0 Root Admin API Reference
listVnfTemplates
List all public, private, and privileged VNF templates.
Request parameters
| Parameter Name | Description | Required |
| templatefilter | Possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : Templates that have been marked as featured and public. * self : Templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns Templates that can be used to deploy a new Instance. * sharedexecutable : Templates ready to be deployed that have been granted to the calling user by another user. * executable : Templates that are owned by the calling user, or public Templates, that can be used to deploy an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins). | true |
| account | List resources by Account. Must be used with the domainId parameter. | false |
| arch | the CPU arch of the template. Valid options are: x86_64, aarch64, s390x | false |
| details | Comma separated list of Template details requested, value can be a list of [all, min] | false |
| domainid | List only resources belonging to the domain specified | false |
| extensionid | ID of the extension for the template | false |
| forcks | list templates that can be used to deploy CKS clusters | false |
| hypervisor | The hypervisor for which to restrict the search | false |
| id | The Template ID | false |
| ids | The IDs of the Templates, mutually exclusive with id | false |
| isready | list templates that are ready to be deployed | false |
| isrecursive | Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| isvnf | flag to list VNF templates or not; true if need to list VNF templates, false otherwise. | false |
| keyword | List by keyword | false |
| listall | If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. | false |
| name | The Template name | false |
| oscategoryid | the ID of the OS category for the template | false |
| page | false | |
| pagesize | false | |
| parenttemplateid | List datadisk Templates by parent Template id | false |
| projectid | List objects by project; if projectid=-1 lists All Instances | false |
| showicon | Flag to display the resource image for the Templates | false |
| showremoved | Show removed Templates as well | false |
| showunique | If set to true, list only unique Templates across zones | false |
| tags | List resources by tags (key/value pairs) | false |
| templatetype | the type of the template | false |
| zoneid | List Templates by zoneId | false |
Response Tags
| Response Name | Description |
| id | The Template ID |
| account | The Account name to which the Template belongs |
| accountid | The Account id to which the Template belongs |
| arch | CPU Arch of the template |
| bits | The processor bit size |
| bootable | True if the ISO is bootable, false otherwise |
| checksum | Checksum of the Template |
| childtemplates | If root disk Template, then IDs of the datas disk Templates this Template owns |
| created | The date this Template was created |
| crossZones | True if the Template is managed across all Zones, false otherwise |
| deployasis | VMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template. |
| deployasisdetails | VMware only: additional key/value details tied with deploy-as-is Template |
| details | Additional key/value details tied with Template |
| directdownload | KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage |
| displaytext | The Template display text |
| domain | The name of the domain to which the Template belongs |
| domainid | The ID of the domain to which the Template belongs |
| domainpath | Path of the Domain the template belongs to |
| downloaddetails | Lists the download progress of a Template across all secondary storages |
| extensionid | The ID of extension linked to this template |
| extensionname | The name of extension linked to this template |
| forcks | If true it indicates that the template can be used for CKS cluster deployments |
| format | The format of the Template. |
| hostid | The ID of the secondary storage host for the Template |
| hostname | The name of the secondary storage host for the Template |
| hypervisor | The hypervisor on which the Template runs |
| icon | Base64 string representation of the resource icon |
| isdynamicallyscalable | True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory |
| isextractable | True if the Template is extractable, false otherwise |
| isfeatured | True if this Template is a featured Template, false otherwise |
| ispublic | True if this Template is a public Template, false otherwise |
| isready | True if the Template is ready to be deployed from, false otherwise. |
| name | The Template name |
| ostypeid | The ID of the OS type for this Template. |
| ostypename | The name of the OS type for this Template. |
| parenttemplateid | If Datadisk Template, then id of the root disk Template this Template belongs to |
| passwordenabled | True if the reset password feature is enabled, false otherwise |
| physicalsize | The physical size of the Template |
| project | The project name of the Template |
| projectid | The project ID of the Template |
| removed | The date this Template was removed |
| requireshvm | True if Template requires HVM enabled, false otherwise |
| size | The size of the Template |
| sourcetemplateid | The Template ID of the parent Template if present |
| sshkeyenabled | True if Template is sshkey enabled, false otherwise |
| status | The status of the Template |
| templatetag | The tag of this Template |
| templatetype | The type of the Template |
| url | The URL which the Template/ISO is registered from |
| userdataid | The id of userdata linked to this Template |
| userdataname | The name of userdata linked to this Template |
| userdataparams | List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata |
| userdatapolicy | The userdata override policy with the userdata provided while deploying Instance |
| zoneid | The ID of the zone for this Template |
| zonename | The name of the zone for this Template |
| jobid | the ID of the latest async job acting on this object |
| jobstatus | the current status of the latest async job acting on this object |