Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 92477 invoked by uid 99); 11 Aug 2016 22:34:44 -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; Thu, 11 Aug 2016 22:34:44 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 19EA3E69AB; Thu, 11 Aug 2016 22:34:44 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: pdion891@apache.org To: commits@cloudstack.apache.org Date: Thu, 11 Aug 2016 22:35:03 -0000 Message-Id: <2cd50c3dd03c4b929f723441e29b91d3@git.apache.org> In-Reply-To: <2fcffb6201104adf90351f3232ecfa10@git.apache.org> References: <2fcffb6201104adf90351f3232ecfa10@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [21/52] [abbrv] cloudstack-www git commit: add api for 4.9.0 archived-at: Thu, 11 Aug 2016 22:34:56 -0000 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/listProjectInvitations.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listProjectInvitations.html b/source/api/apidocs-4.9/apis/listProjectInvitations.html new file mode 100644 index 0000000..4496c71 --- /dev/null +++ b/source/api/apidocs-4.9/apis/listProjectInvitations.html @@ -0,0 +1,133 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listProjectInvitations

Lists project invitations and provides detailed information for listed invitations

+ +

Request parameters

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

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
activeonly	if true, list only active invitations - having Pending state and ones that are not timed out yet	false
domainid	list only resources belonging to the domain specified	false
id	list invitations 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
page		false
pagesize		false
projectid	list by project id	false
state	list invitations by state	false

Response Tags

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

Response Name	Description
id	the id of the invitation
account	the account name of the project's owner
domain	the domain name where the project belongs to
domainid	the domain id the project belongs to
email	the email the invitation was sent to
project	the name of the project
projectid	the id of the project
state	the invitation state

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/listProjects.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listProjects.html b/source/api/apidocs-4.9/apis/listProjects.html new file mode 100644 index 0000000..c4c646e --- /dev/null +++ b/source/api/apidocs-4.9/apis/listProjects.html @@ -0,0 +1,271 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listProjects

Lists projects and provides detailed information for listed projects

+ +

Request parameters

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

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
displaytext	list projects by display text	false
domainid	list only resources belonging to the domain specified	false
id	list projects by project 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 projects by name	false
page		false
pagesize		false
state	list projects by state	false
tags	List projects by tags (key/value pairs)	false

Response Tags

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

Response Name	Description
id	the id of the project
account	the account name of the project's owner
cpuavailable	the total number of cpu cores available to be created for this project
cpulimit	the total number of cpu cores the project can own
cputotal	the total number of cpu cores owned by project
displaytext	the displaytext of the project
domain	the domain name where the project belongs to
domainid	the domain id the project belongs to
ipavailable	the total number of public ip addresses available for this project to acquire
iplimit	the total number of public ip addresses this project can acquire
iptotal	the total number of public ip addresses allocated for this project
memoryavailable	the total memory (in MB) available to be created for this project
memorylimit	the total memory (in MB) the project can own
memorytotal	the total memory (in MB) owned by project
name	the name of the project
networkavailable	the total number of networks available to be created for this project
networklimit	the total number of networks the project can own
networktotal	the total number of networks owned by project
primarystorageavailable	the total primary storage space (in GiB) available to be used for this project
primarystoragelimit	the total primary storage space (in GiB) the project can own
primarystoragetotal	the total primary storage space (in GiB) owned by project
secondarystorageavailable	the total secondary storage space (in GiB) available to be used for this project
secondarystoragelimit	the total secondary storage space (in GiB) the project can own
secondarystoragetotal	the total secondary storage space (in GiB) owned by project
snapshotavailable	the total number of snapshots available for this project
snapshotlimit	the total number of snapshots which can be stored by this project
snapshottotal	the total number of snapshots stored by this project
state	the state of the project
templateavailable	the total number of templates available to be created by this project
templatelimit	the total number of templates which can be created by this project
templatetotal	the total number of templates which have been created by this project
vmavailable	the total number of virtual machines available for this project to acquire
vmlimit	the total number of virtual machines that can be deployed by this project
vmrunning	the total number of virtual machines running for this project
vmstopped	the total number of virtual machines stopped for this project
vmtotal	the total number of virtual machines deployed by this project
volumeavailable	the total volume available for this project
volumelimit	the total volume which can be used by this project
volumetotal	the total volume being used by this project
vpcavailable	the total number of vpcs available to be created for this project
vpclimit	the total number of vpcs the project can own
vpctotal	the total number of vpcs owned by project
*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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/listPublicIpAddresses.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listPublicIpAddresses.html b/source/api/apidocs-4.9/apis/listPublicIpAddresses.html new file mode 100644 index 0000000..1b12aee --- /dev/null +++ b/source/api/apidocs-4.9/apis/listPublicIpAddresses.html @@ -0,0 +1,271 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listPublicIpAddresses

Lists all public ip addresses

+ +

Request parameters

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

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
allocatedonly	limits search results to allocated public IP addresses	false
associatednetworkid	lists all public IP addresses associated to the network specified	false
domainid	list only resources belonging to the domain specified	false
fordisplay	list resources by display flag; only ROOT admin is eligible to pass this parameter	false
forloadbalancing	list only IPs used for load balancing	false
forvirtualnetwork	the virtual network for the IP address	false
id	lists IP address by ID	false
ipaddress	lists the specified IP address	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
issourcenat	list only source NAT IP addresses	false
isstaticnat	list only static NAT IP addresses	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
physicalnetworkid	lists all public IP addresses by physical network ID	false
projectid	list objects by project	false
state	lists all public IP addresses by state	false
tags	List resources by tags (key/value pairs)	false
vlanid	lists all public IP addresses by VLAN ID	false
vpcid	List IPs belonging to the VPC	false
zoneid	lists all public IP addresses by zone ID	false

Response Tags

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

Response Name	Description
id	public IP address id
account	the account the public IP address is associated with
allocated	date the public IP address was acquired
associatednetworkid	the ID of the Network associated with the IP address
associatednetworkname	the name of the Network associated with the IP address
domain	the domain the public IP address is associated with
domainid	the domain ID the public IP address is associated with
fordisplay	is public ip for display to the regular user
forvirtualnetwork	the virtual network for the IP address
ipaddress	public IP address
isportable	is public IP portable across the zones
issourcenat	true if the IP address is a source nat address, false otherwise
isstaticnat	true if this ip is for static nat, false otherwise
issystem	true if this ip is system ip (was allocated as a part of deployVm or createLbRule)
networkid	the ID of the Network where ip belongs to
physicalnetworkid	the physical network this belongs to
project	the project name of the address
projectid	the project id of the ipaddress
purpose	purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value
state	State of the ip address. Can be: Allocatin, Allocated and Releasing
virtualmachinedisplayname	virutal machine display name the ip address is assigned to (not null only for static nat Ip)
virtualmachineid	virutal machine id the ip address is assigned to (not null only for static nat Ip)
virtualmachinename	virutal machine name the ip address is assigned to (not null only for static nat Ip)
vlanid	the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only
vlanname	the VLAN associated with the IP address
vmipaddress	virutal machine (dnat) ip address (not null only for static nat Ip)
vpcid	VPC the ip belongs to
zoneid	the ID of the zone the public IP address belongs to
zonename	the name of the zone the public IP address belongs to
*tags()**	the list of resource tags associated with ip address
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/21afdd57/source/api/apidocs-4.9/apis/listRegions.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listRegions.html b/source/api/apidocs-4.9/apis/listRegions.html new file mode 100644 index 0000000..cd0b27a --- /dev/null +++ b/source/api/apidocs-4.9/apis/listRegions.html @@ -0,0 +1,106 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listRegions

Lists Regions

+ +

Request parameters

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

Parameter Name	Description	Required
id	List Region by region ID.	false
keyword	List by keyword	false
name	List Region by region name.	false
page		false
pagesize		false

Response Tags

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

Response Name	Description
id	the ID of the region
endpoint	the end point of the region
gslbserviceenabled	true if GSLB service is enabled in the region, false otherwise
name	the name of the region
portableipserviceenabled	true if security groups support is enabled, false otherwise

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/listRemoteAccessVpns.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listRemoteAccessVpns.html b/source/api/apidocs-4.9/apis/listRemoteAccessVpns.html new file mode 100644 index 0000000..fd6a4e2 --- /dev/null +++ b/source/api/apidocs-4.9/apis/listRemoteAccessVpns.html @@ -0,0 +1,148 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listRemoteAccessVpns

Lists remote access vpns

+ +

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
fordisplay	list resources by display flag; only ROOT admin is eligible to pass this parameter	false
id	Lists remote access vpn rule with the specified 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
networkid	list remote access VPNs for ceratin network	false
page		false
pagesize		false
projectid	list objects by project	false
publicipid	public ip address id of the vpn server	false

Response Tags

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

Response Name	Description
id	the id of the remote access vpn
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
fordisplay	is vpn for display to the regular user
iprange	the range of ips to allocate to the clients
presharedkey	the ipsec preshared key
project	the project name of the vpn
projectid	the project id of the vpn
publicip	the public ip address of the vpn server
publicipid	the public ip address of the vpn server
state	the state of the rule

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/listResourceDetails.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listResourceDetails.html b/source/api/apidocs-4.9/apis/listResourceDetails.html new file mode 100644 index 0000000..4dd2e11 --- /dev/null +++ b/source/api/apidocs-4.9/apis/listResourceDetails.html @@ -0,0 +1,145 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listResourceDetails

List resource detail(s)

+ +

Request parameters

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

Parameter Name	Description	Required
resourcetype	list by resource type	true
account	list resources by account. Must be used with the domainId parameter.	false
domainid	list only resources belonging to the domain specified	false
fordisplay	if set to true, only details marked with display=true, are returned. False by default	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
value	list by key, value. Needs to be passed only along with key	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/21afdd57/source/api/apidocs-4.9/apis/listResourceLimits.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listResourceLimits.html b/source/api/apidocs-4.9/apis/listResourceLimits.html new file mode 100644 index 0000000..50100bc --- /dev/null +++ b/source/api/apidocs-4.9/apis/listResourceLimits.html @@ -0,0 +1,127 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listResourceLimits

Lists resource limits.

+ +

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 resource limits 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
page		false
pagesize		false
projectid	list objects by project	false
resourcetype	Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for his resources. 9 - Memory. Amount of RAM an account can allocate for his resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use.	false

Response Tags

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

Response Name	Description
account	the account of the resource limit
domain	the domain name of the resource limit
domainid	the domain ID of the resource limit
max	the maximum number of the resource. A -1 means the resource currently has no limit.
project	the project name of the resource limit
projectid	the project id of the resource limit
resourcetype	resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/listRolePermissions.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listRolePermissions.html b/source/api/apidocs-4.9/apis/listRolePermissions.html new file mode 100644 index 0000000..3c37cf3 --- /dev/null +++ b/source/api/apidocs-4.9/apis/listRolePermissions.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listRolePermissions

Lists role permissions

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
roleid	ID of the role	false

Response Tags

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

Response Name	Description
id	the ID of the role permission
description	the description of the role permission
permission	the permission type of the api name or wildcard rule, allow/deny
roleid	the ID of the role to which the role permission belongs
rolename	the name of the role to which the role permission belongs
rule	the api name or wildcard rule

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/listRoles.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listRoles.html b/source/api/apidocs-4.9/apis/listRoles.html new file mode 100644 index 0000000..39679cb --- /dev/null +++ b/source/api/apidocs-4.9/apis/listRoles.html @@ -0,0 +1,97 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listRoles

Lists dynamic roles in CloudStack

+ +

Request parameters

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

Parameter Name	Description	Required
id	List role by role ID.	false
name	List role by role name.	false
type	List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.	false

Response Tags

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

Response Name	Description
id	the ID of the role
description	the description of the role
name	the name of the role
type	the type of the role

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/listRouters.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listRouters.html b/source/api/apidocs-4.9/apis/listRouters.html new file mode 100644 index 0000000..ec3d6d0 --- /dev/null +++ b/source/api/apidocs-4.9/apis/listRouters.html @@ -0,0 +1,331 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listRouters

List routers.

+ +

Request parameters

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

Parameter Name	Description	Required
account	list resources by account. Must be used with the domainId parameter.	false
clusterid	the cluster ID of the router	false
domainid	list only resources belonging to the domain specified	false
forvpc	if true is passed for this parameter, list only VPC routers	false
hostid	the host ID of the router	false
id	the ID of the disk router	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 router	false
networkid	list by network id	false
page		false
pagesize		false
podid	the Pod ID of the router	false
projectid	list objects by project	false
state	the state of the router	false
version	list virtual router elements by version	false
vpcid	List networks by VPC	false
zoneid	the Zone ID of the router	false

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
guestnetworkname	the name of the corresponding guest network
hostid	the host ID for the router
hostname	the hostname for the router
hypervisor	the hypervisor on which the template runs
ip6dns1	the first IPv6 DNS for the router
ip6dns2	the second IPv6 DNS 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
requiresupgrade	true if the router template requires upgrader
role	role of the domain 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
version	the version of template
vpcid	VPC the router belongs to
vpcname	the name of VPC the router 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
deviceid	device id for the network when plugged into the virtual machine
gateway	the gateway of the nic
ip6address	the IPv6 address of network
ip6cidr	the cidr of IPv6 network
ip6gateway	the gateway of IPv6 network
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
nsxlogicalswitch	Id of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchport	Id of the NSX Logical Switch Port (if NSX based), null otherwise
secondaryip	the Secondary ipv4 addr of nic
traffictype	the traffic type of the nic
type	the type of the nic
virtualmachineid	Id of the vm to which the nic belongs

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/21afdd57/source/api/apidocs-4.9/apis/listSSHKeyPairs.html ---------------------------------------------------------------------- diff --git a/source/api/apidocs-4.9/apis/listSSHKeyPairs.html b/source/api/apidocs-4.9/apis/listSSHKeyPairs.html new file mode 100644 index 0000000..8143129 --- /dev/null +++ b/source/api/apidocs-4.9/apis/listSSHKeyPairs.html @@ -0,0 +1,121 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

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

listSSHKeyPairs

List registered keypairs

+ +

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
fingerprint	A public key fingerprint to look for	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	A key pair name to look for	false
page		false
pagesize		false
projectid	list objects by project	false

Response Tags

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

Response Name	Description
account	the owner of the keypair
domain	the domain name of the keypair owner
domainid	the domain id of the keypair owner
fingerprint	Fingerprint of the public key
name	Name of the keypair

+ +