Cosmic User API Reference

listIsos

Lists all available ISO files.

Request parameters

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
bootable	true if the ISO is bootable, false otherwise	false
domainid	list only resources belonging to the domain specified	false
hypervisor	the hypervisor for which to restrict the search	false
id	list ISO by ID	false
isofilter	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 VM. * 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 a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).	false
ispublic	true if the ISO is publicly available to all users, false otherwise.	false
isready	true if this ISO is 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
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	false
name	list all ISOs by name	false
page		false
pagesize		false
projectid	list objects by project	false
showremoved	show removed ISOs as well	false
tags	List resources by tags (key/value pairs)	false
zoneid	the ID of the zone	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
cpuflags	Any CPU flags to pass to VM
created	the date this template was created
crossZones	true if the template is managed across all Zones, false otherwise
details	additional key/value details tied with template
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
isdynamicallyscalable	true if template contains XS tools inorder to support dynamic scaling of VM 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.
isremotegatewaytemplate	true if the template is allowed to take the network gateway ip, false otherwise
maclearning	Enable MAC learning true or false
maintenancepolicy	The maintenance policy for the VM
manufacturerstring	Manufacturer string in hardware
name	the template name
optimisefor	Optimise for Generic of Windows VMs
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
project	the project name of the template
projectid	the project id of the template
removed	the date this template was removed
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 where the templates originally was downloaded from
zoneid	the ID of the zone for this template
zonename	the name of the zone for this template
*tags()**	the list of resource tags associated with tempate
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
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