Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 78D2B200C01 for ; Wed, 4 Jan 2017 11:32:57 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 77421160B4E; Wed, 4 Jan 2017 10:32:57 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 09D82160B4C for ; Wed, 4 Jan 2017 11:32:52 +0100 (CET) Received: (qmail 19393 invoked by uid 500); 4 Jan 2017 10:32:42 -0000 Mailing-List: contact commits-help@cloudstack.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 17275 invoked by uid 99); 4 Jan 2017 10:32:40 -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; Wed, 04 Jan 2017 10:32:40 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 78621DFC49; Wed, 4 Jan 2017 10:32:40 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: bhaisaab@apache.org To: commits@cloudstack.apache.org Date: Wed, 04 Jan 2017 10:32:56 -0000 Message-Id: <0d25175caeb54d37aedf67ae084879f6@git.apache.org> In-Reply-To: <433cd090942a470db80c89b475c90ec4@git.apache.org> References: <433cd090942a470db80c89b475c90ec4@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [18/49] cloudstack-www git commit: content: update freshly built website archived-at: Wed, 04 Jan 2017 10:32:57 -0000 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listVirtualRouterElements.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listVirtualRouterElements.html b/content/api/apidocs-4.9/apis/listVirtualRouterElements.html new file mode 100644 index 0000000..5f3b3e8 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listVirtualRouterElements.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

listVirtualRouterElements

+

Lists all available virtual router elements.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
enabledlist network offerings by enabled statefalse
idlist virtual router elements by idfalse
keywordList by keywordfalse
nspidlist virtual router elements by network service provider idfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the router
accountthe account associated with the provider
domainthe domain associated with the provider
domainidthe domain ID associated with the provider
enabledEnabled/Disabled the service provider
nspidthe physical network service provider id of the provider
projectthe project name of the address
projectidthe project id of the ipaddress
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listVlanIpRanges.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listVlanIpRanges.html b/content/api/apidocs-4.9/apis/listVlanIpRanges.html new file mode 100644 index 0000000..5121fc1 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listVlanIpRanges.html @@ -0,0 +1,181 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

listVlanIpRanges

+

Lists all VLAN IP ranges.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountthe account with which the VLAN IP range is associated. Must be used with the domainId parameter.false
domainidthe domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.false
forvirtualnetworktrue if VLAN is of Virtual type, false if Directfalse
idthe ID of the VLAN IP rangefalse
keywordList by keywordfalse
networkidnetwork id of the VLAN IP rangefalse
pagefalse
pagesizefalse
physicalnetworkidphysical network id of the VLAN IP rangefalse
podidthe Pod ID of the VLAN IP rangefalse
projectidproject who will own the VLANfalse
vlanthe ID or VID of the VLAN. Default is an "untagged" VLAN.false
zoneidthe Zone ID of the VLAN IP rangefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the VLAN IP range
accountthe account of the VLAN IP range
descriptionthe description of the VLAN IP range
domainthe domain name of the VLAN IP range
domainidthe domain ID of the VLAN IP range
endipthe end ip of the VLAN IP range
endipv6the end ipv6 of the VLAN IP range
forvirtualnetworkthe virtual network for the VLAN IP range
gatewaythe gateway of the VLAN IP range
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
netmaskthe netmask of the VLAN IP range
networkidthe network id of vlan range
physicalnetworkidthe physical network this belongs to
podidthe Pod ID for the VLAN IP range
podnamethe Pod name for the VLAN IP range
projectthe project name of the vlan range
projectidthe project id of the vlan range
startipthe start ip of the VLAN IP range
startipv6the start ipv6 of the VLAN IP range
vlanthe ID or VID of the VLAN.
zoneidthe Zone ID of the VLAN IP range
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listVmwareDcs.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listVmwareDcs.html b/content/api/apidocs-4.9/apis/listVmwareDcs.html new file mode 100644 index 0000000..f7ba541 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listVmwareDcs.html @@ -0,0 +1,100 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

listVmwareDcs

+

Retrieves VMware DC(s) associated with a zone.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
zoneidId of the CloudStack zone.true
keywordList by keywordfalse
pagefalse
pagesizefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + +
Response NameDescription
idThe VMware Datacenter ID
nameThe VMware Datacenter name
vcenterThe VMware vCenter name/ip
zoneidthe Zone ID associated with this VMware Datacenter
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listVolumes.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listVolumes.html b/content/api/apidocs-4.9/apis/listVolumes.html new file mode 100644 index 0000000..77fee91 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listVolumes.html @@ -0,0 +1,298 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

listVolumes

+

Lists all volumes.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
diskofferingidlist volumes by disk offeringfalse
displayvolumelist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
domainidlist only resources belonging to the domain specifiedfalse
hostidlist volumes on specified hostfalse
idthe ID of the disk volumefalse
idsthe IDs of the volumes, mutually exclusive with idfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
namethe name of the disk volumefalse
pagefalse
pagesizefalse
podidthe pod id the disk volume belongs tofalse
podidthe pod id the disk volume belongs tofalse
projectidlist objects by projectfalse
storageidthe ID of the storage pool, available to ROOT admin onlyfalse
storageidthe ID of the storage pool, available to ROOT admin onlyfalse
tagsList resources by tags (key/value pairs)false
typethe type of disk volumefalse
virtualmachineidthe ID of the virtual machinefalse
zoneidthe ID of the availability zonefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idID of the disk volume
accountthe account associated with the disk volume
attachedthe date the volume was attached to a VM instance
chaininfothe chain info of the volume
createdthe date the disk volume was created
destroyedthe boolean state of whether the volume is destroyed or not
deviceidthe ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.
diskBytesReadRatebytes read rate of the disk volume
diskBytesWriteRatebytes write rate of the disk volume
diskIopsReadRateio requests read rate of the disk volume
diskIopsWriteRateio requests write rate of the disk volume
diskofferingdisplaytextthe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnamename of the disk offering
displayvolumean optional field whether to the display the volume to the end user or not.
domainthe domain associated with the disk volume
domainidthe ID of the domain associated with the disk volume
hypervisorHypervisor the volume belongs to
isextractabletrue if the volume is extractable, false otherwise
isodisplaytextan alternate display text of the ISO attached to the virtual machine
isoidthe ID of the ISO attached to the virtual machine
isonamethe name of the ISO attached to the virtual machine
maxiopsmax iops of the disk volume
miniopsmin iops of the disk volume
namename of the disk volume
paththe path of the volume
projectthe project name of the vpn
projectidthe project id of the vpn
provisioningtypeprovisioning type used to create volumes.
quiescevmneed quiesce vm or not when taking snapshot
serviceofferingdisplaytextthe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnamename of the service offering for root disk
sizesize of the disk volume
snapshotidID of the snapshot from which this volume was created
statethe state of the disk volume
statusthe status of the volume
storagename of the primary storage hosting the disk volume
storageidid of the primary storage hosting the disk volume; returned to admin user only
storagetypeshared or local storage
templatedisplaytext an alternate display text of the template for the virtual machine
templateidthe ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatenamethe name of the template for the virtual machine
typetype of the disk volume (ROOT or DATADISK)
virtualmachineidid of the virtual machine
vmdisplaynamedisplay name of the virtual machine
vmnamename of the virtual machine
vmstatestate of the virtual machine
zoneidID of the availability zone
zonenamename of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe 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/listVolumesOnFiler.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listVolumesOnFiler.html b/content/api/apidocs-4.9/apis/listVolumesOnFiler.html new file mode 100644 index 0000000..a13ae89 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listVolumesOnFiler.html @@ -0,0 +1,103 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

listVolumesOnFiler

+

List Volumes

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
poolnamepool name.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idvolume id
aggregatenameAggregate name
ipaddressip address
poolnamepool name
sizevolume size
snapshotpolicysnapshot policy
snapshotreservationsnapshot reservation
volumenameVolume name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listVpnConnections.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listVpnConnections.html b/content/api/apidocs-4.9/apis/listVpnConnections.html new file mode 100644 index 0000000..3f99047 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listVpnConnections.html @@ -0,0 +1,178 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

listVpnConnections

+

Lists site to site vpn connection gateways

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idid of the vpn connectionfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
pagefalse
pagesizefalse
projectidlist objects by projectfalse
vpcidid of vpcfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe connection ID
accountthe owner
cidrlistguest cidr list of the customer gateway
createdthe date and time the host was created
domainthe domain name of the owner
domainidthe domain id of the owner
dpdif DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyESP policy of the customer gateway
forceencapif Force NAT Encapsulation is enabled for customer gateway
fordisplayis connection for display to the regular user
gatewaypublic ip address id of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of the customer gateway
ipsecpskIPsec Preshared-Key of the customer gateway
passiveState of vpn connection
projectthe project name
projectidthe project id
publicipthe public IP address
removedthe date and time the host was removed
s2scustomergatewayidthe customer gateway ID
s2svpngatewayidthe vpn gateway ID
stateState of vpn connection
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listVpnCustomerGateways.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listVpnCustomerGateways.html b/content/api/apidocs-4.9/apis/listVpnCustomerGateways.html new file mode 100644 index 0000000..faa01c6 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listVpnCustomerGateways.html @@ -0,0 +1,157 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

listVpnCustomerGateways

+

Lists site to site vpn customer gateways

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
idid of the customer gatewayfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
pagefalse
pagesizefalse
projectidlist objects by projectfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe vpn gateway ID
accountthe owner
cidrlistguest cidr list of the customer gateway
domainthe domain name of the owner
domainidthe domain id of the owner
dpdif DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyIPsec policy of customer gateway
forceencapif Force NAT Encapsulation is enabled for customer gateway
gatewaypublic ip address id of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of customer gateway
ipaddressguest ip of the customer gateway
ipsecpskIPsec preshared-key of customer gateway
namename of the customer gateway
projectthe project name
projectidthe project id
removedthe date and time the host was removed
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listVpnGateways.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listVpnGateways.html b/content/api/apidocs-4.9/apis/listVpnGateways.html new file mode 100644 index 0000000..3f09bcf --- /dev/null +++ b/content/api/apidocs-4.9/apis/listVpnGateways.html @@ -0,0 +1,139 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

listVpnGateways

+

Lists site 2 site vpn gateways

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
fordisplaylist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
idid of the vpn gatewayfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
pagefalse
pagesizefalse
projectidlist objects by projectfalse
vpcidid of vpcfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe vpn gateway ID
accountthe owner
domainthe domain name of the owner
domainidthe domain id of the owner
fordisplayis vpn gateway for display to the regular user
projectthe project name
projectidthe project id
publicipthe public IP address
removedthe date and time the host was removed
vpcidthe vpc id of this gateway
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listVpnUsers.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listVpnUsers.html b/content/api/apidocs-4.9/apis/listVpnUsers.html new file mode 100644 index 0000000..6fc31a3 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listVpnUsers.html @@ -0,0 +1,130 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

listVpnUsers

+

Lists vpn users

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
idThe uuid of the Vpn userfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
pagefalse
pagesizefalse
projectidlist objects by projectfalse
usernamethe username of the vpn user.false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe vpn userID
accountthe account of the remote access vpn
domainthe domain name of the account of the remote access vpn
domainidthe domain id of the account of the remote access vpn
projectthe project name of the vpn
projectidthe project id of the vpn
statethe state of the Vpn User
usernamethe username of the vpn user
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/listZones.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/listZones.html b/content/api/apidocs-4.9/apis/listZones.html new file mode 100644 index 0000000..5f0cab8 --- /dev/null +++ b/content/api/apidocs-4.9/apis/listZones.html @@ -0,0 +1,235 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

listZones

+

Lists zones

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
availabletrue 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
domainidthe ID of the domain associated with the zonefalse
idthe ID of the zonefalse
keywordList by keywordfalse
namethe name of the zonefalse
networktypethe network type of the zone that the virtual machine belongs tofalse
pagefalse
pagesizefalse
showcapacitiesflag to display the capacity of the zonesfalse
tagsList zones by resource tags (key/value pairs)false
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idZone id
allocationstatethe allocation state of the cluster
descriptionZone description
dhcpproviderthe dhcp Provider for the Zone
displaytextthe display text of the zone
dns1the first DNS for the Zone
dns2the second DNS for the Zone
domainNetwork domain name for the networks in the zone
domainidthe UUID of the containing domain, null for public zones
domainnamethe name of the containing domain, null for public zones
guestcidraddressthe guest CIDR address for the Zone
internaldns1the first internal DNS for the Zone
internaldns2the second internal DNS for the Zone
ip6dns1the first IPv6 DNS for the Zone
ip6dns2the second IPv6 DNS for the Zone
localstorageenabledtrue if local storage offering enabled, false otherwise
nameZone name
networktypethe network type of the zone; can be Basic or Advanced
resourcedetailsMeta data associated with the zone (key/value pairs)
securitygroupsenabledtrue if security groups support is enabled, false otherwise
zonetokenZone Token
capacity(*)the capacity of the Zone
capacitytotalthe total capacity available
capacityusedthe capacity currently in use
clusteridthe Cluster ID
clusternamethe Cluster name
percentusedthe percentage of capacity currently in use
podidthe Pod ID
podnamethe Pod name
typethe capacity type
zoneidthe Zone ID
zonenamethe Zone name
tags(*)the list of resource tags associated with zone.
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/071d0632/content/api/apidocs-4.9/apis/lockAccount.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/lockAccount.html b/content/api/apidocs-4.9/apis/lockAccount.html new file mode 100644 index 0000000..9c5a242 --- /dev/null +++ b/content/api/apidocs-4.9/apis/lockAccount.html @@ -0,0 +1,310 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

lockAccount

+

This deprecated function used to locks an account. Look for the API DisableAccount instead

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
accountLocks the specified account.true
domainidLocks the specified account on this domain.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the account
accountdetailsdetails for the account
accounttypeaccount type (admin, domain-admin, user)
cpuavailablethe total number of cpu cores available to be created for this account
cpulimitthe total number of cpu cores the account can own
cputotalthe total number of cpu cores owned by account
defaultzoneidthe default zone of the account
domainname of the Domain the account belongs too
domainidid of the Domain the account belongs too
groupsthe list of acl groups that account belongs to
ipavailablethe total number of public ip addresses available for this account to acquire
iplimitthe total number of public ip addresses this account can acquire
iptotalthe total number of public ip addresses allocated for this account
iscleanuprequiredtrue if the account requires cleanup
isdefaulttrue if account is default, false otherwise
memoryavailablethe total memory (in MB) available to be created for this account
memorylimitthe total memory (in MB) the account can own
memorytotalthe total memory (in MB) owned by account
namethe name of the account
networkavailablethe total number of networks available to be created for this account
networkdomainthe network domain
networklimitthe total number of networks the account can own
networktotalthe total number of networks owned by account
primarystorageavailablethe total primary storage space (in GiB) available to be used for this account
primarystoragelimitthe total primary storage space (in GiB) the account can own
primarystoragetotalthe total primary storage space (in GiB) owned by account
projectavailablethe total number of projects available for administration by this account
projectlimitthe total number of projects the account can own
projecttotalthe total number of projects being administrated by this account
receivedbytesthe total number of network traffic bytes received
roleidthe ID of the role
rolenamethe name of the role
roletypethe type of the role (Admin, ResourceAdmin, DomainAdmin, User)
secondarystorageavailablethe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitthe total secondary storage space (in GiB) the account can own
secondarystoragetotalthe total secondary storage space (in GiB) owned by account
sentbytesthe total number of network traffic bytes sent
snapshotavailablethe total number of snapshots available for this account
snapshotlimitthe total number of snapshots which can be stored by this account
snapshottotalthe total number of snapshots stored by this account
statethe state of the account
templateavailablethe total number of templates available to be created by this account
templatelimitthe total number of templates which can be created by this account
templatetotalthe total number of templates which have been created by this account
vmavailablethe total number of virtual machines available for this account to acquire
vmlimitthe total number of virtual machines that can be deployed by this account
vmrunningthe total number of virtual machines running for this account
vmstoppedthe total number of virtual machines stopped for this account
vmtotalthe total number of virtual machines deployed by this account
volumeavailablethe total volume available for this account
volumelimitthe total volume which can be used by this account
volumetotalthe total volume being used by this account
vpcavailablethe total number of vpcs available to be created for this account
vpclimitthe total number of vpcs the account can own
vpctotalthe total number of vpcs owned by account
user(*)the list of users associated with account
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
iscallerchilddomainthe boolean value representing if the updating target is in caller's child domain
isdefaulttrue if user is default, false otherwise
lastnamethe user lastname
roleidthe ID of the role
rolenamethe name of the role
roletypethe type of the role
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ +