X-Mailer: ASF-Git Admin Mailer Subject: [02/51] [partial] cloudstack-www git commit: Latest API build http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/listVpnGateways.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/listVpnGateways.html b/content/api/apidocs-4.0.0/user/listVpnGateways.html new file mode 100644 index 0000000..9931988 --- /dev/null +++ b/content/api/apidocs-4.0.0/user/listVpnGateways.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

listVpnGateways

Lists site 2 site vpn gateways

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
account	List resources by account. Must be used with the domainId parameter.	false
domainid	list only resources belonging to the domain specified	false
id	id of the vpn gateway	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
page		false
pagesize		false
projectid	list objects by project	false
vpcid	id of vpc	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the vpn gateway ID
account	the owner
domain	the domain name of the owner
domainid	the domain id of the owner
project	the project name
projectid	the project id
publicip	the public IP address
removed	the date and time the host was removed
vpcid	the vpc id of this gateway

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/listVpnUsers.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/listVpnUsers.html b/content/api/apidocs-4.0.0/user/listVpnUsers.html new file mode 100644 index 0000000..f6474b9 --- /dev/null +++ b/content/api/apidocs-4.0.0/user/listVpnUsers.html @@ -0,0 +1,121 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

listVpnUsers

Lists vpn users

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
account	List resources by account. Must be used with the domainId parameter.	false
domainid	list only resources belonging to the domain specified	false
id	the ID of the vpn user	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
page		false
pagesize		false
projectid	list objects by project	false
username	the username of the vpn user.	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the vpn userID
account	the account of the remote access vpn
domain	the domain name of the account of the remote access vpn
domainid	the domain id of the account of the remote access vpn
project	the project name of the vpn
projectid	the project id of the vpn
username	the username of the vpn user

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/listZones.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/listZones.html b/content/api/apidocs-4.0.0/user/listZones.html new file mode 100644 index 0000000..5a77b65 --- /dev/null +++ b/content/api/apidocs-4.0.0/user/listZones.html @@ -0,0 +1,181 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

listZones

Lists zones

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
available	true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.	false
domainid	the ID of the domain associated with the zone	false
id	the ID of the zone	false
keyword	List by keyword	false
page		false
pagesize		false
showcapacities	flag to display the capacity of the zones	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	Zone id
allocationstate	the allocation state of the cluster
description	Zone description
dhcpprovider	the dhcp Provider for the Zone
displaytext	the display text of the zone
dns1	the first DNS for the Zone
dns2	the second DNS for the Zone
domain	Network domain name for the networks in the zone
domainid	the ID of the containing domain, null for public zones
domainname	the name of the containing domain, null for public zones
guestcidraddress	the guest CIDR address for the Zone
internaldns1	the first internal DNS for the Zone
internaldns2	the second internal DNS for the Zone
localstorageenabled	true if local storage offering enabled, false otherwise
name	Zone name
networktype	the network type of the zone; can be Basic or Advanced
securitygroupsenabled	true if security groups support is enabled, false otherwise
vlan	the vlan range of the zone
zonetoken	Zone Token
*capacity()**	the capacity of the Zone
capacitytotal	the total capacity available
capacityused	the capacity currently in use
clusterid	the Cluster ID
clustername	the Cluster name
percentused	the percentage of capacity currently in use
podid	the Pod ID
podname	the Pod name
type	the capacity type
zoneid	the Zone ID
zonename	the Zone name

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/login.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/login.html b/content/api/apidocs-4.0.0/user/login.html new file mode 100644 index 0000000..da36e2e --- /dev/null +++ b/content/api/apidocs-4.0.0/user/login.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

login

Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired.

+ +

Request parameters

+ + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
username	Username	true
password	Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.	true
domain	path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT domain is assumed.	false
domainId	id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precendence	false

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
username	Username
userid	User id
password	Password
domainid	domain ID that the user belongs to
timeout	the time period before the session has expired
account	the account name the user belongs to
firstname	first name of the user
lastname	last name of the user
type	the account type (admin, domain-admin, read-only-admin, user)
timezone	user time zone
timezoneoffset	user time zone offset from UTC 00:00
sessionkey	Session key that can be passed in subsequent Query command calls

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/logout.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/logout.html b/content/api/apidocs-4.0.0/user/logout.html new file mode 100644 index 0000000..5cb928a --- /dev/null +++ b/content/api/apidocs-4.0.0/user/logout.html @@ -0,0 +1,73 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

logout

Logs out the user

+ +

Request parameters

+ + + + +

Parameter Name

Description

Required

Response Tags

+ + + + + + + +

Response Name	Description
description	success if the logout action succeeded

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/migrateVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/migrateVolume.html b/content/api/apidocs-4.0.0/user/migrateVolume.html new file mode 100644 index 0000000..3249219 --- /dev/null +++ b/content/api/apidocs-4.0.0/user/migrateVolume.html @@ -0,0 +1,211 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

migrateVolume

Migrate volume

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
storageid	destination storage pool ID to migrate the volume to	true
volumeid	the ID of the volume	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	ID of the disk volume
account	the account associated with the disk volume
attached	the date the volume was attached to a VM instance
created	the date the disk volume was created
destroyed	the boolean state of whether the volume is destroyed or not
deviceid	the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.
diskofferingdisplaytext	the display text of the disk offering
diskofferingid	ID of the disk offering
diskofferingname	name of the disk offering
domain	the domain associated with the disk volume
domainid	the ID of the domain associated with the disk volume
hypervisor	Hypervisor the volume belongs to
isextractable	true if the volume is extractable, false otherwise
name	name of the disk volume
project	the project name of the vpn
projectid	the project id of the vpn
serviceofferingdisplaytext	the display text of the service offering for root disk
serviceofferingid	ID of the service offering for root disk
serviceofferingname	name of the service offering for root disk
size	size of the disk volume
snapshotid	ID of the snapshot from which this volume was created
state	the state of the disk volume
status	the status of the volume
storage	name of the primary storage hosting the disk volume
storagetype	shared or local storage
type	type of the disk volume (ROOT or DATADISK)
virtualmachineid	id of the virtual machine
vmdisplayname	display name of the virtual machine
vmname	name of the virtual machine
vmstate	state of the virtual machine
zoneid	ID of the availability zone
zonename	name of the availability zone
*tags()**	the list of resource tags associated with volume
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/queryAsyncJobResult.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/queryAsyncJobResult.html b/content/api/apidocs-4.0.0/user/queryAsyncJobResult.html new file mode 100644 index 0000000..28d12a7 --- /dev/null +++ b/content/api/apidocs-4.0.0/user/queryAsyncJobResult.html @@ -0,0 +1,109 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

queryAsyncJobResult

Retrieves the current status of asynchronous job.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
jobid	the ID of the asychronous job	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
accountid	the account that executed the async command
cmd	the async command executed
created	the created date of the job
jobinstanceid	the unique ID of the instance/entity object related to the job
jobinstancetype	the instance/entity object related to the job
jobprocstatus	the progress information of the PENDING job
jobresult	the result reason
jobresultcode	the result code for the job
jobresulttype	the result type
jobstatus	the current job status-should be 0 for PENDING
userid	the user that executed the async command
jobid	the ID of the async job

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/rebootVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/rebootVirtualMachine.html b/content/api/apidocs-4.0.0/user/rebootVirtualMachine.html new file mode 100644 index 0000000..0430b03 --- /dev/null +++ b/content/api/apidocs-4.0.0/user/rebootVirtualMachine.html @@ -0,0 +1,403 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

rebootVirtualMachine

Reboots a virtual machine.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	The ID of the virtual machine	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the virtual machine
account	the account associated with the virtual machine
cpunumber	the number of cpu this virtual machine is running with
cpuspeed	the speed of each cpu
cpuused	the amount of the vm's CPU currently used
created	the date when this virtual machine was created
displayname	user generated name. The name of the virtual machine is returned if no displayname exists.
domain	the name of the domain in which the virtual machine exists
domainid	the ID of the domain in which the virtual machine exists
forvirtualnetwork	the virtual network for the service offering
group	the group name of the virtual machine
groupid	the group ID of the virtual machine
guestosid	Os type ID of the virtual machine
haenable	true if high-availability is enabled, false otherwise
hostid	the ID of the host for the virtual machine
hostname	the name of the host for the virtual machine
hypervisor	the hypervisor on which the template runs
instancename	instance name of the user vm; this parameter is returned to the ROOT admin only
isodisplaytext	an alternate display text of the ISO attached to the virtual machine
isoid	the ID of the ISO attached to the virtual machine
isoname	the name of the ISO attached to the virtual machine
keypair	ssh key-pair
memory	the memory allocated for the virtual machine
name	the name of the virtual machine
networkkbsread	the incoming network traffic on the vm
networkkbswrite	the outgoing network traffic on the host
password	the password (if exists) of the virtual machine
passwordenabled	true if the password rest feature is enabled, false otherwise
project	the project name of the vm
projectid	the project id of the vm
publicip	public IP address id associated with vm via Static nat rule
publicipid	public IP address id associated with vm via Static nat rule
rootdeviceid	device ID of the root volume
rootdevicetype	device type of the root volume
serviceofferingid	the ID of the service offering of the virtual machine
serviceofferingname	the name of the service offering of the virtual machine
state	the state of the virtual machine
templatedisplaytext	an alternate display text of the template for the virtual machine
templateid	the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatename	the name of the template for the virtual machine
zoneid	the ID of the availablility zone for the virtual machine
zonename	the name of the availability zone for the virtual machine
*nic()**	the list of nics associated with vm
id	the ID of the nic
broadcasturi	the broadcast uri of the nic
gateway	the gateway of the nic
ipaddress	the ip address of the nic
isdefault	true if nic is default, false otherwise
isolationuri	the isolation uri of the nic
macaddress	true if nic is default, false otherwise
netmask	the netmask of the nic
networkid	the ID of the corresponding network
networkname	the name of the corresponding network
traffictype	the traffic type of the nic
type	the type of the nic
*securitygroup()**	list of security groups associated with the virtual machine
id	the ID of the security group
account	the account owning the security group
description	the description of the security group
domain	the domain name of the security group
domainid	the domain ID of the security group
name	the name of the security group
project	the project name of the group
projectid	the project id of the group
*egressrule()**	the list of egress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
*ingressrule()**	the list of ingress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
*tags()**	the list of resource tags associated with the rule
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
*tags()**	the list of resource tags associated with vm
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/registerIso.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/registerIso.html b/content/api/apidocs-4.0.0/user/registerIso.html new file mode 100644 index 0000000..a75f62d --- /dev/null +++ b/content/api/apidocs-4.0.0/user/registerIso.html @@ -0,0 +1,247 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

registerIso

Registers an existing ISO into the CloudStack Cloud.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
displaytext	the display text of the ISO. This is usually used for display purposes.	true
name	the name of the ISO	true
url	the URL to where the ISO is currently being hosted	true
zoneid	the ID of the zone you wish to register the ISO to.	true
account	an optional account name. Must be used with domainId.	false
bootable	true if this ISO is bootable. If not passed explicitly its assumed to be true	false
checksum	the MD5 checksum value of this ISO	false
domainid	an optional domainId. If the account parameter is used, domainId must also be used.	false
isextractable	true if the iso or its derivatives are extractable; default is false	false
isfeatured	true if you want this ISO to be featured	false
ispublic	true if you want to register the ISO to be publicly available to all users, false otherwise.	false
ostypeid	the ID of the OS Type that best represents the OS of this ISO. If the iso is bootable this parameter needs to be passed	false
projectid	Register iso for the project	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
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
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.
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
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
*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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/registerSSHKeyPair.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/registerSSHKeyPair.html b/content/api/apidocs-4.0.0/user/registerSSHKeyPair.html new file mode 100644 index 0000000..329df42 --- /dev/null +++ b/content/api/apidocs-4.0.0/user/registerSSHKeyPair.html @@ -0,0 +1,94 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

registerSSHKeyPair

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
name	Name of the keypair	true
publickey	Public key material of the keypair	true
account	an optional account for the ssh key. Must be used with domainId.	false
domainid	an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.	false
projectid	an optional project for the ssh key	false

Response Tags

+ + + + + + + + + + + + + +

Response Name	Description
fingerprint	Fingerprint of the public key
name	Name of the keypair
privatekey	Private key

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/user/registerTemplate.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/user/registerTemplate.html b/content/api/apidocs-4.0.0/user/registerTemplate.html new file mode 100644 index 0000000..5149b35 --- /dev/null +++ b/content/api/apidocs-4.0.0/user/registerTemplate.html @@ -0,0 +1,268 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating User API Reference + +

registerTemplate

Registers an existing template into the CloudStack cloud.

+ +

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter Name	Description	Required
displaytext	the display text of the template. This is usually used for display purposes.	true
format	the format for the template. Possible values include QCOW2, RAW, and VHD.	true
hypervisor	the target hypervisor for the template	true
name	the name of the template	true
ostypeid	the ID of the OS Type that best represents the OS of this template.	true
url	the URL of where the template is hosted. Possible URL include http:// and https://	true
zoneid	the ID of the zone the template is to be hosted on	true
account	an optional accountName. Must be used with domainId.	false
bits	32 or 64 bits support. 64 by default	false
checksum	the MD5 checksum value of this template	false
details	Template details in key/value pairs.	false
domainid	an optional domainId. If the account parameter is used, domainId must also be used.	false
isextractable	true if the template or its derivatives are extractable; default is false	false
isfeatured	true if this template is a featured template, false otherwise	false
ispublic	true if the template is available to all accounts; default is true	false
passwordenabled	true if the template supports the password reset feature; default is false	false
projectid	Register template for the project	false
requireshvm	true if this template requires HVM	false
sshkeyenabled	true if the template supports the sshkey upload feature; default is false	false
templatetag	the tag for this template.	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
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
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.
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
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
*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

+ +