In-Reply-To: <433cd090942a470db80c89b475c90ec4@git.apache.org> References: <433cd090942a470db80c89b475c90ec4@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [20/49] cloudstack-www git commit: content: update freshly built website archived-at: Wed, 04 Jan 2017 10:32:52 -0000 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listStoragePools.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listStoragePools.html b/content/api/apidocs-4.9/apis/listStoragePools.html new file mode 100644 index 0000000..d756fb8 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listStoragePools.html @@ -0,0 +1,184 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listStoragePools

Lists storage pools.

+ +

Request parameters

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

Parameter Name	Description	Required
clusterid	list storage pools belongig to the specific cluster	false
id	the ID of the storage pool	false
ipaddress	the IP address for the storage pool	false
keyword	List by keyword	false
name	the name of the storage pool	false
page		false
pagesize		false
path	the storage pool path	false
podid	the Pod ID for the storage pool	false
scope	the ID of the storage pool	false
zoneid	the Zone ID for the storage pool	false

Response Tags

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

Response Name	Description
id	the ID of the storage pool
capacityiops	IOPS CloudStack can provision from this storage pool
clusterid	the ID of the cluster for the storage pool
clustername	the name of the cluster for the storage pool
created	the date and time the storage pool was created
disksizeallocated	the host's currently allocated disk size
disksizetotal	the total disk size of the storage pool
disksizeused	the host's currently used disk size
hypervisor	the hypervisor type of the storage pool
ipaddress	the IP address of the storage pool
name	the name of the storage pool
overprovisionfactor	the overprovisionfactor for the storage pool
path	the storage pool path
podid	the Pod ID of the storage pool
podname	the Pod name of the storage pool
scope	the scope of the storage pool
state	the state of the storage pool
storagecapabilities	the storage pool capabilities
suitableformigration	true if this pool is suitable to migrate a volume, false otherwise
tags	the tags for the storage pool
type	the storage pool type
zoneid	the Zone ID of the storage pool
zonename	the Zone name of the storage pool
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/071d0632/content/api/apidocs-4.9/apis/listStorageProviders.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listStorageProviders.html b/content/api/apidocs-4.9/apis/listStorageProviders.html new file mode 100644 index 0000000..028cf6f --- /dev/null +++ b/content/api/apidocs-4.9/apis/listStorageProviders.html @@ -0,0 +1,94 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listStorageProviders

Lists storage providers.

+ +

Request parameters

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

Parameter Name	Description	Required
type	the type of storage provider: either primary or image	true
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

+ + + + + + + + + + +

Response Name	Description
name	the name of the storage provider
type	the type of the storage provider: primary or image provider

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listStorageTags.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listStorageTags.html b/content/api/apidocs-4.9/apis/listStorageTags.html new file mode 100644 index 0000000..f885174 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listStorageTags.html @@ -0,0 +1,94 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listStorageTags

Lists storage tags

+ +

Request parameters

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

Parameter Name	Description	Required
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	the ID of the storage tag
name	the name of the storage tag
poolid	the pool ID of the storage tag

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listSupportedNetworkServices.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listSupportedNetworkServices.html b/content/api/apidocs-4.9/apis/listSupportedNetworkServices.html new file mode 100644 index 0000000..77dd4a8 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listSupportedNetworkServices.html @@ -0,0 +1,130 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listSupportedNetworkServices

Lists all network services provided by CloudStack or for the given Provider.

+ +

Request parameters

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

Parameter Name	Description	Required
keyword	List by keyword	false
page		false
pagesize		false
provider	network service provider name	false
service	network service name to list providers and capabilities of	false

Response Tags

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

Response Name	Description
name	the service name
*capability()**	the list of capabilities
canchooseservicecapability	can this service capability value can be choosable while creatine network offerings
name	the capability name
value	the capability value
*provider()**	the service provider name
id	uuid of the network provider
canenableindividualservice	true if individual services can be enabled/disabled
destinationphysicalnetworkid	the destination physical network
name	the provider name
physicalnetworkid	the physical network this belongs to
servicelist	services for this provider
state	state of the network provider

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listSwifts.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listSwifts.html b/content/api/apidocs-4.9/apis/listSwifts.html new file mode 100644 index 0000000..69fd423 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listSwifts.html @@ -0,0 +1,115 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listSwifts

List Swift.

+ +

Request parameters

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

Parameter Name	Description	Required
id	the id of the swift	false
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	the ID of the image store
details	the details of the image store
name	the name of the image store
protocol	the protocol of the image store
providername	the provider name of the image store
scope	the scope of the image store
url	the url of the image store
zoneid	the Zone ID of the image store
zonename	the Zone name of the image store

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listSystemVms.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listSystemVms.html b/content/api/apidocs-4.9/apis/listSystemVms.html new file mode 100644 index 0000000..c5f511c --- /dev/null +++ b/content/api/apidocs-4.9/apis/listSystemVms.html @@ -0,0 +1,193 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listSystemVms

List system virtual machines.

+ +

Request parameters

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

Parameter Name	Description	Required
hostid	the host ID of the system VM	false
id	the ID of the system VM	false
keyword	List by keyword	false
name	the name of the system VM	false
page		false
pagesize		false
podid	the Pod ID of the system VM	false
state	the state of the system VM	false
storageid	the storage ID where vm's volumes belong to	false
systemvmtype	the system VM type. Possible types are "consoleproxy" and "secondarystoragevm".	false
zoneid	the Zone ID of the system VM	false

Response Tags

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

Response Name	Description
id	the ID of the system VM
activeviewersessions	the number of active console sessions for the console proxy system vm
created	the date and time the system VM was created
dns1	the first DNS for the system VM
dns2	the second DNS for the system VM
gateway	the gateway for the system VM
hostid	the host ID for the system VM
hostname	the hostname for the system VM
hypervisor	the hypervisor on which the template runs
jobid	the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.
jobstatus	the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.
linklocalip	the link local IP address for the system vm
linklocalmacaddress	the link local MAC address for the system vm
linklocalnetmask	the link local netmask for the system vm
name	the name of the system VM
networkdomain	the network domain for the system VM
podid	the Pod ID for the system VM
privateip	the private IP address for the system VM
privatemacaddress	the private MAC address for the system VM
privatenetmask	the private netmask for the system VM
publicip	the public IP address for the system VM
publicmacaddress	the public MAC address for the system VM
publicnetmask	the public netmask for the system VM
state	the state of the system VM
systemvmtype	the system VM type
templateid	the template ID for the system VM
zoneid	the Zone ID for the system VM
zonename	the Zone name for the system VM

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listTags.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listTags.html b/content/api/apidocs-4.9/apis/listTags.html new file mode 100644 index 0000000..254ee4a --- /dev/null +++ b/content/api/apidocs-4.9/apis/listTags.html @@ -0,0 +1,145 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listTags

List resource tag(s)

+ +

Request parameters

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

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
customer	list by customer name	false
domainid	list only resources belonging to the domain specified	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
key	list by key	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
resourceid	list by resource id	false
resourcetype	list by resource type	false
value	list by value	false

Response Tags

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

Response Name	Description
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listTemplatePermissions.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listTemplatePermissions.html b/content/api/apidocs-4.9/apis/listTemplatePermissions.html new file mode 100644 index 0000000..d79deeb --- /dev/null +++ b/content/api/apidocs-4.9/apis/listTemplatePermissions.html @@ -0,0 +1,94 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listTemplatePermissions

List template visibility and all accounts that have permissions to view this template.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the template ID	true

Response Tags

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

Response Name	Description
id	the template ID
account	the list of accounts the template is available for
domainid	the ID of the domain to which the template belongs
ispublic	true if this template is a public template, false otherwise
projectids	the list of projects the template is available for

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listTemplates.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listTemplates.html b/content/api/apidocs-4.9/apis/listTemplates.html new file mode 100644 index 0000000..2a219cf --- /dev/null +++ b/content/api/apidocs-4.9/apis/listTemplates.html @@ -0,0 +1,235 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listTemplates

List all public, private, and privileged 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 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).	true
account	list resources by account. Must be used with the domainId parameter.	false
domainid	list only resources belonging to the domain specified	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
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 template name	false
page		false
pagesize		false
projectid	list objects by project	false
showremoved	show removed templates as well	false
tags	List resources by tags (key/value pairs)	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
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/VMWare 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.
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
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
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listTrafficMonitors.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listTrafficMonitors.html b/content/api/apidocs-4.9/apis/listTrafficMonitors.html new file mode 100644 index 0000000..3b9cee8 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listTrafficMonitors.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listTrafficMonitors

List traffic monitor Hosts.

+ +

Request parameters

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

Parameter Name	Description	Required
zoneid	zone Id	true
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	the ID of the external firewall
ipaddress	the management IP address of the external firewall
numretries	the number of times to retry requests to the external firewall
timeout	the timeout (in seconds) for requests to the external firewall
zoneid	the zone ID of the external firewall

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listTrafficTypeImplementors.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listTrafficTypeImplementors.html b/content/api/apidocs-4.9/apis/listTrafficTypeImplementors.html new file mode 100644 index 0000000..9b2bf6e --- /dev/null +++ b/content/api/apidocs-4.9/apis/listTrafficTypeImplementors.html @@ -0,0 +1,94 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listTrafficTypeImplementors

Lists implementors of implementor of a network traffic type or implementors of all network traffic types

+ +

Request parameters

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

Parameter Name	Description	Required
keyword	List by keyword	false
page		false
pagesize		false
traffictype	Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor	false

Response Tags

+ + + + + + + + + + +

Response Name	Description
traffictype	network traffic type
traffictypeimplementor	implementor of network traffic type

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listTrafficTypes.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listTrafficTypes.html b/content/api/apidocs-4.9/apis/listTrafficTypes.html new file mode 100644 index 0000000..23cc0b3 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listTrafficTypes.html @@ -0,0 +1,109 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listTrafficTypes

Lists traffic types of a given physical network.

+ +

Request parameters

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

Parameter Name	Description	Required
physicalnetworkid	the Physical Network ID	true
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	uuid of the network provider
canenableindividualservice	true if individual services can be enabled/disabled
destinationphysicalnetworkid	the destination physical network
name	the provider name
physicalnetworkid	the physical network this belongs to
servicelist	services for this provider
state	state of the network provider

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listUcsBlades.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listUcsBlades.html b/content/api/apidocs-4.9/apis/listUcsBlades.html new file mode 100644 index 0000000..3a5b8ea --- /dev/null +++ b/content/api/apidocs-4.9/apis/listUcsBlades.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listUcsBlades

List ucs blades

+ +

Request parameters

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

Parameter Name	Description	Required
ucsmanagerid	ucs manager id	true
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	ucs blade id
bladedn	ucs blade dn
hostid	cloudstack host id this blade associates to
profiledn	associated ucs profile dn
ucsmanagerid	ucs manager id

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listUcsManagers.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listUcsManagers.html b/content/api/apidocs-4.9/apis/listUcsManagers.html new file mode 100644 index 0000000..4ecc813 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listUcsManagers.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listUcsManagers

List ucs manager

+ +

Request parameters

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

Parameter Name	Description	Required
id	the ID of the ucs manager	false
keyword	List by keyword	false
page		false
pagesize		false
zoneid	the zone id	false

Response Tags

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

Response Name	Description
id	the ID of the ucs manager
name	the name of ucs manager
url	the url of ucs manager
zoneid	the zone ID of ucs manager

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listUcsProfiles.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listUcsProfiles.html b/content/api/apidocs-4.9/apis/listUcsProfiles.html new file mode 100644 index 0000000..b71afca --- /dev/null +++ b/content/api/apidocs-4.9/apis/listUcsProfiles.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

listUcsProfiles

List profile in ucs manager

+ +

Request parameters

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

Parameter Name	Description	Required
ucsmanagerid	the id for the ucs manager	true
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

+ + + + + + + +

Response Name	Description
ucsdn	ucs profile dn

+ +