Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 9347 invoked by uid 99); 12 May 2015 07:20:28 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 12 May 2015 07:20:28 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 20267E17E7; Tue, 12 May 2015 07:20:28 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: sebgoa@apache.org To: commits@cloudstack.apache.org Date: Tue, 12 May 2015 07:20:50 -0000 Message-Id: <30f737772a224997b10bdac5de1406d7@git.apache.org> In-Reply-To: <2584744b3895405fa98bef3e158d33b5@git.apache.org> References: <2584744b3895405fa98bef3e158d33b5@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [24/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/root_admin/listCapabilities.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/listCapabilities.html b/source/api/apidocs-4.0.0/root_admin/listCapabilities.html new file mode 100644 index 0000000..408dda0 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/listCapabilities.html @@ -0,0 +1,91 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listCapabilities

Lists capabilities

+ +

Request parameters

+ + + + +

Parameter Name

Description

Required

Response Tags

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

Response Name	Description
allowusercreateprojects	true if regular user is allowed to create projects
cloudstackversion	version of the cloud stack
customdiskofferingmaxsize	maximum size that can be specified when create disk from disk offering with custom size
projectinviterequired	If invitation confirmation is required when add account to project
securitygroupsenabled	true if security groups support is enabled, false otherwise
supportELB	true if region supports elastic load balancer on basic zones
userpublictemplateenabled	true if user and domain admins can set templates to be shared, false otherwise

+ +

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

+ +

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

listCapacity

Lists all the system wide capacities.

+ +

Request parameters

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

Parameter Name	Description	Required
clusterid	lists capacity by the Cluster ID	false
fetchlatest	recalculate capacities and fetch the latest	false
keyword	List by keyword	false
page		false
pagesize		false
podid	lists capacity by the Pod ID	false
sortby	Sort the results. Available values: Usage	false
type	lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9.	false
zoneid	lists capacity by the Zone ID	false

Response Tags

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

Response Name	Description
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/root_admin/listClusters.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/listClusters.html b/source/api/apidocs-4.0.0/root_admin/listClusters.html new file mode 100644 index 0000000..3254eda --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/listClusters.html @@ -0,0 +1,169 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listClusters

Lists clusters.

+ +

Request parameters

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

Parameter Name	Description	Required
allocationstate	lists clusters by allocation state	false
clustertype	lists clusters by cluster type	false
hypervisor	lists clusters by hypervisor type	false
id	lists clusters by the cluster ID	false
keyword	List by keyword	false
managedstate	whether this cluster is managed by cloudstack	false
name	lists clusters by the cluster name	false
page		false
pagesize		false
podid	lists clusters by Pod ID	false
showcapacities	flag to display the capacity of the clusters	false
zoneid	lists clusters by Zone ID	false

Response Tags

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

Response Name	Description
id	the cluster ID
allocationstate	the allocation state of the cluster
clustertype	the type of the cluster
hypervisortype	the hypervisor type of the cluster
managedstate	whether this cluster is managed by cloudstack
name	the cluster name
podid	the Pod ID of the cluster
podname	the Pod name of the cluster
zoneid	the Zone ID of the cluster
zonename	the Zone name of the cluster
*capacity()**	the capacity of the Cluster
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/root_admin/listConfigurations.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/listConfigurations.html b/source/api/apidocs-4.0.0/root_admin/listConfigurations.html new file mode 100644 index 0000000..9745ac9 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/listConfigurations.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listConfigurations

Lists all configurations.

+ +

Request parameters

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

Parameter Name	Description	Required
category	lists configurations by category	false
keyword	List by keyword	false
name	lists configuration by name	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
category	the category of the configuration
description	the description of the configuration
name	the name of the configuration
value	the value of the configuration

+ +

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

+ +

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

listDiskOfferings

Lists all available disk offerings.

+ +

Request parameters

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

Parameter Name	Description	Required
domainid	the ID of the domain of the disk offering.	false
id	ID of the disk offering	false
keyword	List by keyword	false
name	name of the disk offering	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	unique ID of the disk offering
created	the date this disk offering was created
disksize	the size of the disk offering in GB
displaytext	an alternate display text of the disk offering.
domain	the domain name this disk offering belongs to. Ignore this information as it is not currently applicable.
domainid	the domain ID this disk offering belongs to. Ignore this information as it is not currently applicable.
iscustomized	true if disk offering uses custom size, false otherwise
name	the name of the disk offering
storagetype	the storage type for this disk offering
tags	the tags for the disk offering

+ +

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

+ +

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

listDomainChildren

Lists all children domains belonging to a specified domain

+ +

Request parameters

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

Parameter Name	Description	Required
id	list children domain by parent domain ID.	false
isrecursive	to return the entire tree, use the value "true". To return the first level children, use the value "false".	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 children domains by name	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	the ID of the domain
haschild	whether the domain has one or more sub-domains
level	the level of the domain
name	the name of the domain
networkdomain	the network domain
parentdomainid	the domain ID of the parent domain
parentdomainname	the domain name of the parent domain
path	the path of the domain

+ +

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

+ +

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

listDomains

Lists domains and provides detailed information for listed domains

+ +

Request parameters

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

Parameter Name	Description	Required
id	List domain by domain ID.	false
keyword	List by keyword	false
level	List domains by domain level.	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 domain by domain name.	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	the ID of the domain
haschild	whether the domain has one or more sub-domains
level	the level of the domain
name	the name of the domain
networkdomain	the network domain
parentdomainid	the domain ID of the parent domain
parentdomainname	the domain name of the parent domain
path	the path of the domain

+ +

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

+ +

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

listEventTypes

List Event Types

+ +

Request parameters

+ + + + +

Parameter Name

Description

Required

Response Tags

+ + + + + + + +

Response Name	Description
name	Event Type

+ +

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

+ +

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

listEvents

A command to list events.

+ +

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
duration	the duration of the event	false
enddate	the end date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss")	false
entrytime	the time the event was entered	false
id	the ID of the event	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
level	the event level (INFO, WARN, ERROR)	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
startdate	the start date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss")	false
type	the event type (see event types)	false

Response Tags

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

Response Name	Description
id	the ID of the event
account	the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)
created	the date the event was created
description	a brief description of the event
domain	the name of the account's domain
domainid	the id of the account's domain
level	the event level (INFO, WARN, ERROR)
parentid	whether the event is parented
project	the project name of the address
projectid	the project id of the ipaddress
state	the state of the event
type	the type of the event (see event types)
username	the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)

+ +

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

+ +

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

listFirewallRules

Lists all firewall rules for an IP address.

+ +

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	Lists rule with the specified ID.	false
ipaddressid	the id of IP address of the firwall services	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
tags	List resources by tags (key/value pairs)	false

Response Tags

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

Response Name	Description
id	the ID of the firewall rule
cidrlist	the cidr list to forward traffic from
endport	the ending port of firewall rule's port range
icmpcode	error code for this icmp message
icmptype	type of the icmp message being sent
ipaddress	the public ip address for the firewall rule
ipaddressid	the public ip address id for the firewall rule
protocol	the protocol of the firewall rule
startport	the starting port of firewall rule's port range
state	the state of the 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

+ +

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

+ +

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

listHosts

Lists hosts.

+ +

Request parameters

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

Parameter Name	Description	Required
clusterid	lists hosts existing in particular cluster	false
details	comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]	false
hahost	if true, list only hosts dedicated to HA	false
id	the id of the host	false
keyword	List by keyword	false
name	the name of the host	false
page		false
pagesize		false
podid	the Pod ID for the host	false
resourcestate	list hosts by resource state. Resource state represents current state determined by admin of host, valule can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]	false
state	the state of the host	false
type	the host type	false
virtualmachineid	lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM	false
zoneid	the Zone ID for the host	false

Response Tags

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

Response Name	Description
id	the ID of the host
averageload	the cpu average load on the host
capabilities	capabilities of the host
clusterid	the cluster ID of the host
clustername	the cluster name of the host
clustertype	the cluster type of the cluster that host belongs to
cpuallocated	the amount of the host's CPU currently allocated
cpunumber	the CPU number of the host
cpuspeed	the CPU speed of the host
cpuused	the amount of the host's CPU currently used
cpuwithoverprovisioning	the amount of the host's CPU after applying the cpu.overprovisioning.factor
created	the date and time the host was created
disconnected	true if the host is disconnected. False otherwise.
disksizeallocated	the host's currently allocated disk size
disksizetotal	the total disk size of the host
events	events available for the host
hahost	true if the host is Ha host (dedicated to vms started by HA process; false otherwise
hasenoughcapacity	true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise
hosttags	comma-separated list of tags for the host
hypervisor	the host hypervisor
hypervisorversion	the hypervisor version
ipaddress	the IP address of the host
islocalstorageactive	true if local storage is active, false otherwise
lastpinged	the date and time the host was last pinged
managementserverid	the management server ID of the host
memoryallocated	the amount of the host's memory currently allocated
memorytotal	the memory total of the host
memoryused	the amount of the host's memory currently used
name	the name of the host
networkkbsread	the incoming network traffic on the host
networkkbswrite	the outgoing network traffic on the host
oscategoryid	the OS category ID of the host
oscategoryname	the OS category name of the host
podid	the Pod ID of the host
podname	the Pod name of the host
removed	the date and time the host was removed
resourcestate	the resource state of the host
state	the state of the host
suitableformigration	true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise
type	the host type
version	the host version
zoneid	the Zone ID of the host
zonename	the Zone name of the host
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/root_admin/listHypervisorCapabilities.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.0.0/root_admin/listHypervisorCapabilities.html b/source/api/apidocs-4.0.0/root_admin/listHypervisorCapabilities.html new file mode 100644 index 0000000..ac21c02 --- /dev/null +++ b/source/api/apidocs-4.0.0/root_admin/listHypervisorCapabilities.html @@ -0,0 +1,100 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listHypervisorCapabilities

Lists all hypervisor capabilities.

+ +

Request parameters

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

Parameter Name	Description	Required
hypervisor	the hypervisor for which to restrict the search	false
id	ID of the hypervisor capability	false
keyword	List by keyword	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	the ID of the hypervisor capabilities row
hypervisor	the hypervisor type
hypervisorversion	the hypervisor version
maxguestslimit	the maximum number of guest vms recommended for this hypervisor
securitygroupenabled	true if security group is supported

+ +

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

+ +

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

listHypervisors

List hypervisors

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
zoneid	the zone id for listing hypervisors.	false

Response Tags

+ + + + + + + +

Response Name	Description
name	Hypervisor name

+ +

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

+ +

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

listInstanceGroups

Lists vm groups

+ +

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	list instance groups by 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	list instance groups by name	false
page		false
pagesize		false
projectid	list objects by project	false

Response Tags

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

Response Name	Description
id	the id of the instance group
account	the account owning the instance group
created	time and date the instance group was created
domain	the domain name of the instance group
domainid	the domain ID of the instance group
name	the name of the instance group
project	the project name of the group
projectid	the project id of the group

+ +

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

+ +

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

listIpForwardingRules

List the ip forwarding rules

+ +

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	Lists rule with the specified ID.	false
ipaddressid	list the rule belonging to this public ip address	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
virtualmachineid	Lists all rules applied to the specified Vm.	false

Response Tags

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

Response Name	Description
id	the ID of the port forwarding rule
cidrlist	the cidr list to forward traffic from
ipaddress	the public ip address for the port forwarding rule
ipaddressid	the public ip address id for the port forwarding rule
privateendport	the ending port of port forwarding rule's private port range
privateport	the starting port of port forwarding rule's private port range
protocol	the protocol of the port forwarding rule
publicendport	the ending port of port forwarding rule's private port range
publicport	the starting port of port forwarding rule's public port range
state	the state of the rule
virtualmachinedisplayname	the VM display name for the port forwarding rule
virtualmachineid	the VM ID for the port forwarding rule
virtualmachinename	the VM name for the port forwarding 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

+ +

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

+ +

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

listIsoPermissions

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

+ +