listTemplates
- Developers
- API
- Commands
- listTemplates
List all public, private, and privileged templates.
Request Parameters
Parameter Name | Description | Required |
templatefilter | possible values are "featured", "self", "self-executable", "executable", and "community".* featured-templates that are featured and are public* self-templates that have been registered/created by the owner* selfexecutable-templates that have been registered/created by the owner that can be used to deploy a new VM* executable-all templates that can be used to deploy a new VM* community-templates that are public. | true |
account | list template by account. Must be used with the domainId parameter. | false |
domainid | list all templates in specified domain. If used with the account parameter, lists all templates for an account in the specified domain. | false |
hypervisor | the hypervisor for which to restrict the search | false |
id | the template ID | false |
keyword | List by keyword | false |
name | the template name | false |
page | false | |
pagesize | 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 |
bootable | true if the ISO is bootable, false otherwise |
checksum | checksum of the template |
created | the date this template was created |
crossZones | true if the template is managed across all Zones, false otherwise |
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 |
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 |
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. |
jobid | shows the current pending asynchronous job ID. This tag is not returned if no current pending jobs are acting on the template |
jobstatus | shows the current pending asynchronous job status |
name | the template name |
ostypeid | the ID of the OS type for this template. |
ostypename | the name of the OS type for this template. |
passwordenabled | true if the reset password feature is enabled, false otherwise |
removed | the date this template was removed |
size | the size of the template |
sourcetemplateid | the template ID of the parent template if present |
status | the status of the template |
templatetag | the tag of this template |
templatetype | the type of the template |
zoneid | the ID of the zone for this template |
zonename | the name of the zone for this template |
Related Pages:
listNetworks, restartNetwork, updateNetwork, associateIpAddress, disassociateIpAddress, listPublicIpAddresses, createLoadBalancerRule, deleteLoadBalancerRule, removeFromLoadBalancerRule, assignToLoadBalancerRule, listLoadBalancerRules, listLoadBalancerRuleInstances, updateLoadBalancerRule, listPortForwardingRules, createPortForwardingRule, deletePortForwardingRule, createFirewallRule, deleteFirewallRule, listFirewallRules, createRemoteAccessVpn, deleteRemoteAccessVpn, listRemoteAccessVpns, enableStaticNat, createIpForwardingRule, deleteIpForwardingRule, listIpForwardingRules, disableStaticNat, extractVolume, listZones, login, logout, listAccounts, queryAsyncJobResult, listAsyncJobs, listServiceOfferings, listDiskOfferings, registerSSHKeyPair, createSSHKeyPair, deleteSSHKeyPair, listSSHKeyPairs, listVirtualMachines, destroyVirtualMachine, rebootVirtualMachine, stopVirtualMachine, resetPasswordForVirtualMachine, changeServiceForVirtualMachine, updateVirtualMachine, getVMPassword, deployVirtualMachine, startVirtualMachine, listSnapshots, listSnapshotPolicies, deleteSnapshot, createSnapshot, createSnapshotPolicy, deleteSnapshotPolicies, createTemplate, registerTemplate, updateTemplate, copyTemplate, deleteTemplate, updateTemplatePermissions, listTemplatePermissions, extractTemplate, listSecurityGroups, createSecurityGroup, deleteSecurityGroup, authorizeSecurityGroupIngress, revokeSecurityGroupIngress, listVolumes, createVolume, attachVolume, detachVolume, deleteVolume, listNetworkOfferings, createNetwork, deleteNetwork, listTags, createTags, deleteTags