In-Reply-To: <2584744b3895405fa98bef3e158d33b5@git.apache.org> References: <2584744b3895405fa98bef3e158d33b5@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [39/51] [partial] cloudstack-www git commit: Adding API html pages http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listVolumes.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listVolumes.html b/source/api/apidocs-4.0.0/domain_admin/listVolumes.html new file mode 100644 index 0000000..862751d --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listVolumes.html @@ -0,0 +1,253 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listVolumes

Lists all volumes.

+ +

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
hostid	list volumes on specified host	false
id	the ID of the disk volume	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	the name of the disk volume	false
page		false
pagesize		false
podid	the pod id the disk volume belongs to	false
projectid	list objects by project	false
tags	List resources by tags (key/value pairs)	false
type	the type of disk volume	false
virtualmachineid	the ID of the virtual machine	false
zoneid	the ID of the availability zone	false

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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listVpnConnections.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listVpnConnections.html b/source/api/apidocs-4.0.0/domain_admin/listVpnConnections.html new file mode 100644 index 0000000..5d0669b --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listVpnConnections.html @@ -0,0 +1,160 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listVpnConnections

Lists site to site vpn connection 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 connection	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
cidrlist	guest cidr list of the customer gateway
created	the date and time the host was created
domain	the domain name of the owner
domainid	the domain id of the owner
dpd	if DPD is enabled for customer gateway
esplifetime	Lifetime of ESP SA of customer gateway
esppolicy	ESP policy of the customer gateway
gateway	public ip address id of the customer gateway
ikelifetime	Lifetime of IKE SA of customer gateway
ikepolicy	IKE policy of the customer gateway
ipsecpsk	IPsec Preshared-Key of the customer gateway
project	the project name
projectid	the project id
publicip	the public IP address
removed	the date and time the host was removed
s2scustomergatewayid	the customer gateway ID
s2svpngatewayid	the vpn gateway ID
state	State of vpn connection

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listVpnCustomerGateways.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listVpnCustomerGateways.html b/source/api/apidocs-4.0.0/domain_admin/listVpnCustomerGateways.html new file mode 100644 index 0000000..8de51e5 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listVpnCustomerGateways.html @@ -0,0 +1,148 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

listVpnCustomerGateways

Lists site to site vpn customer 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 customer 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

Response Tags

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

Response Name	Description
id	the vpn gateway ID
account	the owner
cidrlist	guest cidr list of the customer gateway
domain	the domain name of the owner
domainid	the domain id of the owner
dpd	if DPD is enabled for customer gateway
esplifetime	Lifetime of ESP SA of customer gateway
esppolicy	IPsec policy of customer gateway
gateway	public ip address id of the customer gateway
ikelifetime	Lifetime of IKE SA of customer gateway
ikepolicy	IKE policy of customer gateway
ipaddress	guest ip of the customer gateway
ipsecpsk	IPsec preshared-key of customer gateway
name	name of the customer gateway
project	the project name
projectid	the project id
removed	the date and time the host was removed

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listVpnGateways.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listVpnGateways.html b/source/api/apidocs-4.0.0/domain_admin/listVpnGateways.html new file mode 100644 index 0000000..8588095 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listVpnGateways.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin 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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listVpnUsers.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listVpnUsers.html b/source/api/apidocs-4.0.0/domain_admin/listVpnUsers.html new file mode 100644 index 0000000..24ac6e3 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listVpnUsers.html @@ -0,0 +1,121 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin 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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/listZones.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/listZones.html b/source/api/apidocs-4.0.0/domain_admin/listZones.html new file mode 100644 index 0000000..689b1f9 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/listZones.html @@ -0,0 +1,181 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin 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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/login.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/login.html b/source/api/apidocs-4.0.0/domain_admin/login.html new file mode 100644 index 0000000..4c8ef9f --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/login.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin 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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/logout.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/logout.html b/source/api/apidocs-4.0.0/domain_admin/logout.html new file mode 100644 index 0000000..392c86e --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/logout.html @@ -0,0 +1,73 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin 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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/migrateVolume.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/migrateVolume.html b/source/api/apidocs-4.0.0/domain_admin/migrateVolume.html new file mode 100644 index 0000000..2db924e --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/migrateVolume.html @@ -0,0 +1,211 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin 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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/queryAsyncJobResult.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/queryAsyncJobResult.html b/source/api/apidocs-4.0.0/domain_admin/queryAsyncJobResult.html new file mode 100644 index 0000000..a726e06 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/queryAsyncJobResult.html @@ -0,0 +1,109 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin 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/5c2e0541/source/api/apidocs-4.0.0/domain_admin/rebootRouter.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/domain_admin/rebootRouter.html b/source/api/apidocs-4.0.0/domain_admin/rebootRouter.html new file mode 100644 index 0000000..d422cf9 --- /dev/null +++ b/source/api/apidocs-4.0.0/domain_admin/rebootRouter.html @@ -0,0 +1,226 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Domain Admin API Reference + +

rebootRouter

Starts a router.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the ID of the router	true

Response Tags

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

Response Name	Description
id	the id of the router
account	the account associated with the router
created	the date and time the router was created
dns1	the first DNS for the router
dns2	the second DNS for the router
domain	the domain associated with the router
domainid	the domain ID associated with the router
gateway	the gateway for the router
guestipaddress	the guest IP address for the router
guestmacaddress	the guest MAC address for the router
guestnetmask	the guest netmask for the router
guestnetworkid	the ID of the corresponding guest network
hostid	the host ID for the router
hostname	the hostname for the router
isredundantrouter	if this router is an redundant virtual router
linklocalip	the link local IP address for the router
linklocalmacaddress	the link local MAC address for the router
linklocalnetmask	the link local netmask for the router
linklocalnetworkid	the ID of the corresponding link local network
name	the name of the router
networkdomain	the network domain for the router
podid	the Pod ID for the router
project	the project name of the address
projectid	the project id of the ipaddress
publicip	the public IP address for the router
publicmacaddress	the public MAC address for the router
publicnetmask	the public netmask for the router
publicnetworkid	the ID of the corresponding public network
redundantstate	the state of redundant virtual router
scriptsversion	the version of scripts
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 router
templateid	the template ID for the router
templateversion	the version of template
vpcid	VPC the network belongs to
zoneid	the Zone ID for the router
zonename	the Zone name for the router
*nic()**	the list of nics associated with the router
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

+ +