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 61CE5200B72 for ; Fri, 12 Aug 2016 02:38:01 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 600E3160ABA; Fri, 12 Aug 2016 00:38:01 +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 0AF78160A93 for ; Fri, 12 Aug 2016 02:37:58 +0200 (CEST) Received: (qmail 22669 invoked by uid 500); 12 Aug 2016 00:37:53 -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 21789 invoked by uid 99); 12 Aug 2016 00:37:52 -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; Fri, 12 Aug 2016 00:37:52 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 83693E38BC; Fri, 12 Aug 2016 00:37:52 +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: Fri, 12 Aug 2016 00:38:09 -0000 Message-Id: <3597d90547e647ec9ba54a98787df156@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [18/50] [abbrv] cloudstack-www git commit: site build for 4.9.0 archived-at: Fri, 12 Aug 2016 00:38:01 -0000 http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/97caa4e4/content/api/apidocs-4.9/apis/lockUser.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/lockUser.html b/content/api/apidocs-4.9/apis/lockUser.html new file mode 100644 index 0000000..bb80247 --- /dev/null +++ b/content/api/apidocs-4.9/apis/lockUser.html @@ -0,0 +1,139 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

lockUser

+

Locks a user account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + +
Parameter NameDescriptionRequired
idLocks 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
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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/97caa4e4/content/api/apidocs-4.9/apis/login.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/login.html b/content/api/apidocs-4.9/apis/login.html new file mode 100644 index 0000000..4b1df7b --- /dev/null +++ b/content/api/apidocs-4.9/apis/login.html @@ -0,0 +1,121 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

login

+

Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + + + + +
Parameter NameDescriptionRequired
passwordHashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.true
usernameUsernametrue
domainPath of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.false
domainIdThe id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precendencefalse
+
+
+

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Response NameDescription
accountthe account name the user belongs to
domainidDomain ID that the user belongs to
firstnamefirst name of the user
lastnamelast name of the user
registeredIs user registered
sessionkeySession key that can be passed in subsequent Query command calls
timeoutthe time period before the session has expired
timezoneuser time zone
typethe account type (admin, domain-admin, read-only-admin, user)
useridUser ID
usernameUsername
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/97caa4e4/content/api/apidocs-4.9/apis/logout.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/logout.html b/content/api/apidocs-4.9/apis/logout.html new file mode 100644 index 0000000..ba69a71 --- /dev/null +++ b/content/api/apidocs-4.9/apis/logout.html @@ -0,0 +1,79 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

logout

+

Logs out the user

+
+
+ +
+
+
+

Request parameters

+ + + + +
Parameter NameDescriptionRequired
+
+
+

Response Tags

+ + + + + + + +
Response NameDescription
descriptionResponse description
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/97caa4e4/content/api/apidocs-4.9/apis/markDefaultZoneForAccount.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/markDefaultZoneForAccount.html b/content/api/apidocs-4.9/apis/markDefaultZoneForAccount.html new file mode 100644 index 0000000..2e7a75c --- /dev/null +++ b/content/api/apidocs-4.9/apis/markDefaultZoneForAccount.html @@ -0,0 +1,313 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

markDefaultZoneForAccount

+

Marks a default zone for this account

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
accountName of the account that is to be marked.true
domainidMarks the account that belongs to the specified domain.true
zoneidThe Zone ID with which the account is to be marked.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
+
+
+
+
+
+ +
+
+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/97caa4e4/content/api/apidocs-4.9/apis/migrateSystemVm.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/migrateSystemVm.html b/content/api/apidocs-4.9/apis/migrateSystemVm.html new file mode 100644 index 0000000..98a4a08 --- /dev/null +++ b/content/api/apidocs-4.9/apis/migrateSystemVm.html @@ -0,0 +1,166 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

migrateSystemVm

+

Attempts Migration of a system virtual machine to the host specified.

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + +
Parameter NameDescriptionRequired
hostiddestination Host ID to migrate VM totrue
virtualmachineidthe ID of the 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
hypervisorthe hypervisor on which the template runs
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/97caa4e4/content/api/apidocs-4.9/apis/migrateVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/migrateVirtualMachine.html b/content/api/apidocs-4.9/apis/migrateVirtualMachine.html new file mode 100644 index 0000000..99f63d1 --- /dev/null +++ b/content/api/apidocs-4.9/apis/migrateVirtualMachine.html @@ -0,0 +1,502 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

migrateVirtualMachine

+

Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
virtualmachineidthe ID of the virtual machinetrue
hostidDestination Host ID to migrate VM to. Required for live migrating a VM from host to hostfalse
storageidDestination storage pool ID to migrate VM volumes to. Required for migrating the root disk volumefalse
+
+
+

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
detailsVm details in key/value pairs.
diskioreadthe read (io) of disk on the vm
diskiowritethe write (io) of disk on the vm
diskkbsreadthe read (bytes) of disk on the vm
diskkbswritethe write (bytes) of disk on the vm
diskofferingidthe ID of the disk offering of the virtual machine
diskofferingnamethe name of the disk offering of the virtual machine
displaynameuser generated name. The name of the virtual machine is returned if no displayname exists.
displayvman optional field whether to the display the vm to the end user or not.
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
isdynamicallyscalabletrue if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.
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
memoryintfreekbsthe internal memory thats free in vm
memorykbsthe memory used by the vm
memorytargetkbsthe target memory in vm
namethe name of the virtual machine
networkkbsreadthe incoming network traffic on the vm
networkkbswritethe outgoing network traffic on the host
ostypeidOS type id of the vm
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
servicestateState of the Service from LB rule
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
useridthe user's ID who deployed the virtual machine
usernamethe user's name who deployed the virtual machine
vgputhe vgpu type used by the virtual machine
zoneidthe ID of the availablility zone for the virtual machine
zonenamethe name of the availability zone for the virtual machine
affinitygroup(*)list of affinity groups associated with the virtual machine
idthe ID of the affinity group
accountthe account owning the affinity group
descriptionthe description of the affinity group
domainthe domain name of the affinity group
domainidthe domain ID of the affinity group
namethe name of the affinity group
projectthe project name of the affinity group
projectidthe project ID of the affinity group
typethe type of the affinity group
virtualmachineIdsvirtual machine IDs associated with this affinity group
nic(*)the list of nics associated with vm
idthe ID of the nic
broadcasturithe broadcast uri of the nic
deviceiddevice id for the network when plugged into the virtual machine
gatewaythe gateway of the nic
ip6addressthe IPv6 address of network
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
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
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
secondaryipthe Secondary ipv4 addr of nic
traffictypethe traffic type of the nic
typethe type of the nic
virtualmachineidId of the vm to which the nic belongs
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
virtualmachinecountthe number of virtualmachines associated with this securitygroup
virtualmachineidsthe list of virtualmachine ids associated with this securitygroup
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
tags(*)the list of resource tags associated with the 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
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
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/97caa4e4/content/api/apidocs-4.9/apis/migrateVirtualMachineWithVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.9/apis/migrateVirtualMachineWithVolume.html b/content/api/apidocs-4.9/apis/migrateVirtualMachineWithVolume.html new file mode 100644 index 0000000..e1c202b --- /dev/null +++ b/content/api/apidocs-4.9/apis/migrateVirtualMachineWithVolume.html @@ -0,0 +1,502 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+ + Apache CloudStack v4.9.0 Root Admin API Reference + +

+

migrateVirtualMachineWithVolume

+

Attempts Migration of a VM with its volumes to a different host

+
+
+ +
+
+
+

Request parameters

+ + + + + + + + + + + + + +
Parameter NameDescriptionRequired
hostidDestination Host ID to migrate VM to.true
virtualmachineidthe ID of the virtual machinetrue
migratetoStorage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=<uuid>&migrateto[volume-index].pool=<uuid>Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume=<uuid> indicates the UUID of the volume that you want to migrate, and pool=<uuid> indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>false
+
+
+

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
detailsVm details in key/value pairs.
diskioreadthe read (io) of disk on the vm
diskiowritethe write (io) of disk on the vm
diskkbsreadthe read (bytes) of disk on the vm
diskkbswritethe write (bytes) of disk on the vm
diskofferingidthe ID of the disk offering of the virtual machine
diskofferingnamethe name of the disk offering of the virtual machine
displaynameuser generated name. The name of the virtual machine is returned if no displayname exists.
displayvman optional field whether to the display the vm to the end user or not.
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
isdynamicallyscalabletrue if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.
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
memoryintfreekbsthe internal memory thats free in vm
memorykbsthe memory used by the vm
memorytargetkbsthe target memory in vm
namethe name of the virtual machine
networkkbsreadthe incoming network traffic on the vm
networkkbswritethe outgoing network traffic on the host
ostypeidOS type id of the vm
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
servicestateState of the Service from LB rule
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
useridthe user's ID who deployed the virtual machine
usernamethe user's name who deployed the virtual machine
vgputhe vgpu type used by the virtual machine
zoneidthe ID of the availablility zone for the virtual machine
zonenamethe name of the availability zone for the virtual machine
affinitygroup(*)list of affinity groups associated with the virtual machine
idthe ID of the affinity group
accountthe account owning the affinity group
descriptionthe description of the affinity group
domainthe domain name of the affinity group
domainidthe domain ID of the affinity group
namethe name of the affinity group
projectthe project name of the affinity group
projectidthe project ID of the affinity group
typethe type of the affinity group
virtualmachineIdsvirtual machine IDs associated with this affinity group
nic(*)the list of nics associated with vm
idthe ID of the nic
broadcasturithe broadcast uri of the nic
deviceiddevice id for the network when plugged into the virtual machine
gatewaythe gateway of the nic
ip6addressthe IPv6 address of network
ip6cidrthe cidr of IPv6 network
ip6gatewaythe gateway of IPv6 network
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
nsxlogicalswitchId of the NSX Logical Switch (if NSX based), null otherwise
nsxlogicalswitchportId of the NSX Logical Switch Port (if NSX based), null otherwise
secondaryipthe Secondary ipv4 addr of nic
traffictypethe traffic type of the nic
typethe type of the nic
virtualmachineidId of the vm to which the nic belongs
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
virtualmachinecountthe number of virtualmachines associated with this securitygroup
virtualmachineidsthe list of virtualmachine ids associated with this securitygroup
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
tags(*)the list of resource tags associated with the 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
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
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object
+
+
+
+
+
+ +
+
+ +