Return-Path: X-Original-To: apmail-cloudstack-commits-archive@www.apache.org Delivered-To: apmail-cloudstack-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id F07A118654 for ; Tue, 12 May 2015 07:24:29 +0000 (UTC) Received: (qmail 42182 invoked by uid 500); 12 May 2015 07:24:27 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 42071 invoked by uid 500); 12 May 2015 07:24:27 -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 40884 invoked by uid 99); 12 May 2015 07:24:26 -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:24:26 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id B2C37E17E2; Tue, 12 May 2015 07:24:26 +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:24:51 -0000 Message-Id: <03077835a8f8463bb0f3d86f95069ea0@git.apache.org> In-Reply-To: <03da320163d144338193f10c11569269@git.apache.org> References: <03da320163d144338193f10c11569269@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [26/51] [abbrv] [partial] cloudstack-www git commit: Latest API build http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/destroyRouter.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/destroyRouter.html b/content/api/apidocs-4.0.0/root_admin/destroyRouter.html new file mode 100644 index 0000000..7d96d56 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/destroyRouter.html @@ -0,0 +1,226 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

+

destroyRouter

+

Destroys a router.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe ID of the routertrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the router
accountthe account associated with the router
createdthe date and time the router was created
dns1the first DNS for the router
dns2the second DNS for the router
domainthe domain associated with the router
domainidthe domain ID associated with the router
gatewaythe gateway for the router
guestipaddressthe guest IP address for the router
guestmacaddressthe guest MAC address for the router
guestnetmaskthe guest netmask for the router
guestnetworkidthe ID of the corresponding guest network
hostidthe host ID for the router
hostnamethe hostname for the router
isredundantrouterif this router is an redundant virtual router
linklocalipthe link local IP address for the router
linklocalmacaddressthe link local MAC address for the router
linklocalnetmaskthe link local netmask for the router
linklocalnetworkidthe ID of the corresponding link local network
namethe name of the router
networkdomainthe network domain for the router
podidthe Pod ID for the router
projectthe project name of the address
projectidthe project id of the ipaddress
publicipthe public IP address for the router
publicmacaddressthe public MAC address for the router
publicnetmaskthe public netmask for the router
publicnetworkidthe ID of the corresponding public network
redundantstatethe state of redundant virtual router
scriptsversionthe version of scripts
serviceofferingidthe ID of the service offering of the virtual machine
serviceofferingnamethe name of the service offering of the virtual machine
statethe state of the router
templateidthe template ID for the router
templateversionthe version of template
vpcidVPC the network belongs to
zoneidthe Zone ID for the router
zonenamethe Zone name for the router
nic(*)the list of nics associated with the router
idthe ID of the nic
broadcasturithe broadcast uri of the nic
gatewaythe gateway of the nic
ipaddressthe ip address of the nic
isdefaulttrue if nic is default, false otherwise
isolationurithe isolation uri of the nic
macaddresstrue if nic is default, false otherwise
netmaskthe netmask of the nic
networkidthe ID of the corresponding network
networknamethe name of the corresponding network
traffictypethe traffic type of the nic
typethe type of the nic
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/destroySystemVm.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/destroySystemVm.html b/content/api/apidocs-4.0.0/root_admin/destroySystemVm.html new file mode 100644 index 0000000..13520f2 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/destroySystemVm.html @@ -0,0 +1,154 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

+

destroySystemVm

+

Destroyes a system virtual machine.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the system virtual machinetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the system VM
activeviewersessionsthe number of active console sessions for the console proxy system vm
createdthe date and time the system VM was created
dns1the first DNS for the system VM
dns2the second DNS for the system VM
gatewaythe gateway for the system VM
hostidthe host ID for the system VM
hostnamethe hostname for the system VM
jobidthe job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.
jobstatusthe job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.
linklocalipthe link local IP address for the system vm
linklocalmacaddressthe link local MAC address for the system vm
linklocalnetmaskthe link local netmask for the system vm
namethe name of the system VM
networkdomainthe network domain for the system VM
podidthe Pod ID for the system VM
privateipthe private IP address for the system VM
privatemacaddressthe private MAC address for the system VM
privatenetmaskthe private netmask for the system VM
publicipthe public IP address for the system VM
publicmacaddressthe public MAC address for the system VM
publicnetmaskthe public netmask for the system VM
statethe state of the system VM
systemvmtypethe system VM type
templateidthe template ID for the system VM
zoneidthe Zone ID for the system VM
zonenamethe Zone name for the system VM
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/destroyVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/destroyVirtualMachine.html b/content/api/apidocs-4.0.0/root_admin/destroyVirtualMachine.html new file mode 100644 index 0000000..941faec --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/destroyVirtualMachine.html @@ -0,0 +1,403 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

+

destroyVirtualMachine

+

Destroys a virtual machine. Once destroyed, only the administrator can recover it.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idThe ID of the virtual machinetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the virtual machine
accountthe account associated with the virtual machine
cpunumberthe number of cpu this virtual machine is running with
cpuspeedthe speed of each cpu
cpuusedthe amount of the vm's CPU currently used
createdthe date when this virtual machine was created
displaynameuser generated name. The name of the virtual machine is returned if no displayname exists.
domainthe name of the domain in which the virtual machine exists
domainidthe ID of the domain in which the virtual machine exists
forvirtualnetworkthe virtual network for the service offering
groupthe group name of the virtual machine
groupidthe group ID of the virtual machine
guestosidOs type ID of the virtual machine
haenabletrue if high-availability is enabled, false otherwise
hostidthe ID of the host for the virtual machine
hostnamethe name of the host for the virtual machine
hypervisorthe hypervisor on which the template runs
instancenameinstance name of the user vm; this parameter is returned to the ROOT admin only
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
keypairssh key-pair
memorythe memory allocated for the virtual machine
namethe name of the virtual machine
networkkbsreadthe incoming network traffic on the vm
networkkbswritethe outgoing network traffic on the host
passwordthe password (if exists) of the virtual machine
passwordenabledtrue if the password rest feature is enabled, false otherwise
projectthe project name of the vm
projectidthe project id of the vm
publicippublic IP address id associated with vm via Static nat rule
publicipidpublic IP address id associated with vm via Static nat rule
rootdeviceiddevice ID of the root volume
rootdevicetypedevice type of the root volume
serviceofferingidthe ID of the service offering of the virtual machine
serviceofferingnamethe name of the service offering of the virtual machine
statethe state of the virtual machine
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
zoneidthe ID of the availablility zone for the virtual machine
zonenamethe name of the availability zone for the virtual machine
nic(*)the list of nics associated with vm
idthe ID of the nic
broadcasturithe broadcast uri of the nic
gatewaythe gateway of the nic
ipaddressthe ip address of the nic
isdefaulttrue if nic is default, false otherwise
isolationurithe isolation uri of the nic
macaddresstrue if nic is default, false otherwise
netmaskthe netmask of the nic
networkidthe ID of the corresponding network
networknamethe name of the corresponding network
traffictypethe traffic type of the nic
typethe type of the nic
securitygroup(*)list of security groups associated with the virtual machine
idthe ID of the security group
accountthe account owning the security group
descriptionthe description of the security group
domainthe domain name of the security group
domainidthe domain ID of the security group
namethe name of the security group
projectthe project name of the group
projectidthe project id of the group
egressrule(*)the list of egress rules associated with the security group
accountaccount owning the security group rule
cidrthe CIDR notation for the base IP address of the security group rule
endportthe ending IP of the security group rule
icmpcodethe code for the ICMP message response
icmptypethe type of the ICMP message response
protocolthe protocol of the security group rule
ruleidthe id of the security group rule
securitygroupnamesecurity group name
startportthe starting IP of the security group rule
ingressrule(*)the list of ingress rules associated with the security group
accountaccount owning the security group rule
cidrthe CIDR notation for the base IP address of the security group rule
endportthe ending IP of the security group rule
icmpcodethe code for the ICMP message response
icmptypethe type of the ICMP message response
protocolthe protocol of the security group rule
ruleidthe id of the security group rule
securitygroupnamesecurity group name
startportthe starting IP of the security group rule
tags(*)the list of resource tags associated with the rule
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
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
tags(*)the list of resource tags associated with vm
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
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/edeec656/content/api/apidocs-4.0.0/root_admin/detachIso.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/detachIso.html b/content/api/apidocs-4.0.0/root_admin/detachIso.html new file mode 100644 index 0000000..00dc784 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/detachIso.html @@ -0,0 +1,403 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

+

detachIso

+

Detaches any ISO file (if any) currently attached to a virtual machine.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidThe ID of the virtual machinetrue
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe ID of the virtual machine
accountthe account associated with the virtual machine
cpunumberthe number of cpu this virtual machine is running with
cpuspeedthe speed of each cpu
cpuusedthe amount of the vm's CPU currently used
createdthe date when this virtual machine was created
displaynameuser generated name. The name of the virtual machine is returned if no displayname exists.
domainthe name of the domain in which the virtual machine exists
domainidthe ID of the domain in which the virtual machine exists
forvirtualnetworkthe virtual network for the service offering
groupthe group name of the virtual machine
groupidthe group ID of the virtual machine
guestosidOs type ID of the virtual machine
haenabletrue if high-availability is enabled, false otherwise
hostidthe ID of the host for the virtual machine
hostnamethe name of the host for the virtual machine
hypervisorthe hypervisor on which the template runs
instancenameinstance name of the user vm; this parameter is returned to the ROOT admin only
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
keypairssh key-pair
memorythe memory allocated for the virtual machine
namethe name of the virtual machine
networkkbsreadthe incoming network traffic on the vm
networkkbswritethe outgoing network traffic on the host
passwordthe password (if exists) of the virtual machine
passwordenabledtrue if the password rest feature is enabled, false otherwise
projectthe project name of the vm
projectidthe project id of the vm
publicippublic IP address id associated with vm via Static nat rule
publicipidpublic IP address id associated with vm via Static nat rule
rootdeviceiddevice ID of the root volume
rootdevicetypedevice type of the root volume
serviceofferingidthe ID of the service offering of the virtual machine
serviceofferingnamethe name of the service offering of the virtual machine
statethe state of the virtual machine
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
zoneidthe ID of the availablility zone for the virtual machine
zonenamethe name of the availability zone for the virtual machine
nic(*)the list of nics associated with vm
idthe ID of the nic
broadcasturithe broadcast uri of the nic
gatewaythe gateway of the nic
ipaddressthe ip address of the nic
isdefaulttrue if nic is default, false otherwise
isolationurithe isolation uri of the nic
macaddresstrue if nic is default, false otherwise
netmaskthe netmask of the nic
networkidthe ID of the corresponding network
networknamethe name of the corresponding network
traffictypethe traffic type of the nic
typethe type of the nic
securitygroup(*)list of security groups associated with the virtual machine
idthe ID of the security group
accountthe account owning the security group
descriptionthe description of the security group
domainthe domain name of the security group
domainidthe domain ID of the security group
namethe name of the security group
projectthe project name of the group
projectidthe project id of the group
egressrule(*)the list of egress rules associated with the security group
accountaccount owning the security group rule
cidrthe CIDR notation for the base IP address of the security group rule
endportthe ending IP of the security group rule
icmpcodethe code for the ICMP message response
icmptypethe type of the ICMP message response
protocolthe protocol of the security group rule
ruleidthe id of the security group rule
securitygroupnamesecurity group name
startportthe starting IP of the security group rule
ingressrule(*)the list of ingress rules associated with the security group
accountaccount owning the security group rule
cidrthe CIDR notation for the base IP address of the security group rule
endportthe ending IP of the security group rule
icmpcodethe code for the ICMP message response
icmptypethe type of the ICMP message response
protocolthe protocol of the security group rule
ruleidthe id of the security group rule
securitygroupnamesecurity group name
startportthe starting IP of the security group rule
tags(*)the list of resource tags associated with the rule
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
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
tags(*)the list of resource tags associated with vm
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
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/edeec656/content/api/apidocs-4.0.0/root_admin/detachVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/detachVolume.html b/content/api/apidocs-4.0.0/root_admin/detachVolume.html new file mode 100644 index 0000000..fe56279 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/detachVolume.html @@ -0,0 +1,214 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

+

detachVolume

+

Detaches a disk volume from a virtual machine.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
deviceidthe device ID on the virtual machine where volume is detached fromfalse
idthe ID of the disk volumefalse
virtualmachineidthe ID of the virtual machine where the volume is detached fromfalse
+
+
+

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
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.
diskofferingdisplaytextthe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnamename of the disk offering
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
namename of the disk volume
projectthe project name of the vpn
projectidthe project id of the vpn
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
storagetypeshared or local storage
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
tags(*)the list of resource tags associated with volume
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
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/edeec656/content/api/apidocs-4.0.0/root_admin/disableAccount.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/disableAccount.html b/content/api/apidocs-4.0.0/root_admin/disableAccount.html new file mode 100644 index 0000000..2b2ae83 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/disableAccount.html @@ -0,0 +1,244 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

+

disableAccount

+

Disables an account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
lockIf true, only lock the account; else disable the accounttrue
accountDisables specified account.false
domainidDisables specified account in this domain.false
idAccount idfalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
idthe id of the account
accountdetailsdetails for the account
accounttypeaccount type (admin, domain-admin, user)
defaultzoneidthe default zone of the account
domainname of the Domain the account belongs too
domainidid of the Domain the account belongs too
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
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
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
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
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/disableStaticNat.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/disableStaticNat.html b/content/api/apidocs-4.0.0/root_admin/disableStaticNat.html new file mode 100644 index 0000000..8224c4f --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/disableStaticNat.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

+

disableStaticNat

+

Disables static rule for given ip address

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
ipaddressidthe public IP address id for which static nat feature is being disableedtrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/disableUser.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/disableUser.html b/content/api/apidocs-4.0.0/root_admin/disableUser.html new file mode 100644 index 0000000..4fc52a2 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/disableUser.html @@ -0,0 +1,118 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

+

disableUser

+

Disables a user account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idDisables user by user ID.true
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
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
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/disassociateIpAddress.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/disassociateIpAddress.html b/content/api/apidocs-4.0.0/root_admin/disassociateIpAddress.html new file mode 100644 index 0000000..2ef58f3 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/disassociateIpAddress.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

+

disassociateIpAddress

+

Disassociates an ip address from the account.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idthe id of the public ip address to disassociatetrue
+
+
+

Response Tags

+ + + + + + + + + + +
Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully
+
+
+
+
+
+ +
+
+ +