You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by da...@apache.org on 2024/12/30 15:18:38 UTC
(cloudstack-go) 14/25: updated listApis.json with latest 4.19.2 from cloudmonkey cli
This is an automated email from the ASF dual-hosted git repository.
dahn pushed a commit to branch pr90
in repository https://gitbox.apache.org/repos/asf/cloudstack-go.git
commit 3b147e268bc674852afea25a0a6d8349297241b3
Author: tonymmm1 <to...@mail.magnatox.com>
AuthorDate: Tue Jul 23 20:28:54 2024 -0500
updated listApis.json with latest 4.19.2 from cloudmonkey cli
---
generate/listApis.json | 131804 +++++++++++++++++++++++-----------------------
1 file changed, 66422 insertions(+), 65382 deletions(-)
diff --git a/generate/listApis.json b/generate/listApis.json
index bbc5c76..2f0a9f1 100644
--- a/generate/listApis.json
+++ b/generate/listApis.json
@@ -22,6 +22,17 @@
],
"related": "",
"response": [
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "resourceobjecttype"
+ },
{
"description": "id of the resource",
"name": "resourceid",
@@ -32,23 +43,12 @@
"name": "base64image",
"type": "string"
},
- {},
- {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "resourceobjecttype"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- }
+ {}
],
"since": "4.16.0.0"
},
@@ -58,19 +58,34 @@
"name": "createVPCOffering",
"params": [
{
- "description": "the display text of the vpc offering, defaults to the 'name'",
+ "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6",
"length": 255,
- "name": "displaytext",
+ "name": "internetprotocol",
"required": false,
+ "since": "4.17.0",
"type": "string"
},
{
- "description": "desired service capabilities as part of vpc offering",
+ "description": "set to true if the offering is to be enabled during creation. Default is false",
"length": 255,
- "name": "servicecapabilitylist",
+ "name": "enable",
"required": false,
- "since": "4.4",
- "type": "map"
+ "since": "4.16",
+ "type": "boolean"
+ },
+ {
+ "description": "services supported by the vpc offering",
+ "length": 255,
+ "name": "supportedservices",
+ "required": true,
+ "type": "list"
+ },
+ {
+ "description": "the name of the vpc offering",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
},
{
"description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network",
@@ -88,21 +103,6 @@
"since": "4.13",
"type": "list"
},
- {
- "description": "the name of the vpc offering",
- "length": 255,
- "name": "name",
- "required": true,
- "type": "string"
- },
- {
- "description": "set to true if the offering is to be enabled during creation. Default is false",
- "length": 255,
- "name": "enable",
- "required": false,
- "since": "4.16",
- "type": "boolean"
- },
{
"description": "the ID of the containing domain(s), null for public offerings",
"length": 255,
@@ -112,11 +112,10 @@
"type": "list"
},
{
- "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6",
+ "description": "the display text of the vpc offering, defaults to the 'name'",
"length": 255,
- "name": "internetprotocol",
+ "name": "displaytext",
"required": false,
- "since": "4.17.0",
"type": "string"
},
{
@@ -128,18 +127,54 @@
"type": "uuid"
},
{
- "description": "services supported by the vpc offering",
+ "description": "desired service capabilities as part of vpc offering",
"length": 255,
- "name": "supportedservices",
- "required": true,
- "type": "list"
+ "name": "servicecapabilitylist",
+ "required": false,
+ "since": "4.4",
+ "type": "map"
}
],
"related": "updateVPCOffering,listVPCOfferings",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the date this vpc offering was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if vpc offering is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
+ "name": "distributedvpcrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zone",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "state of the vpc offering. Can be Disabled/Enabled",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domain",
"type": "string"
},
{
@@ -156,13 +191,13 @@
"name": "capability",
"response": [
{
- "description": "the capability value",
- "name": "value",
+ "description": "the capability name",
+ "name": "name",
"type": "string"
},
{
- "description": "the capability name",
- "name": "name",
+ "description": "the capability value",
+ "name": "value",
"type": "string"
},
{
@@ -173,23 +208,13 @@
],
"type": "list"
},
- {
- "description": "the service name",
- "name": "name",
- "type": "string"
- },
{
"description": "the service provider name",
"name": "provider",
"response": [
{
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
- {
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
+ "description": "the provider name",
+ "name": "name",
"type": "string"
},
{
@@ -198,98 +223,73 @@
"type": "string"
},
{
- "description": "state of the network provider",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the provider name",
- "name": "name",
+ "description": "uuid of the network provider",
+ "name": "id",
"type": "string"
},
{
- "description": "uuid of the network provider",
- "name": "id",
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
"type": "string"
},
{
"description": "services for this provider",
"name": "servicelist",
"type": "list"
+ },
+ {
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
}
],
"type": "list"
+ },
+ {
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
}
],
"type": "list"
},
{},
{
- "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
- "name": "distributedvpcrouter",
- "type": "boolean"
- },
- {
- "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domain",
+ "description": "the internet protocol of the vpc offering",
+ "name": "internetprotocol",
"type": "string"
},
{
- "description": "the date this vpc offering was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zone",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the id of the vpc offering",
"name": "id",
"type": "string"
},
+ {},
{
"description": "the name of the vpc offering",
"name": "name",
"type": "string"
},
- {
- "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "state of the vpc offering. Can be Disabled/Enabled",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "true if vpc offering is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
{
"description": " indicated if the offering can support region level vpc",
"name": "supportsregionLevelvpc",
"type": "boolean"
},
{
- "description": "the internet protocol of the vpc offering",
- "name": "internetprotocol",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
- },
- {}
+ }
]
},
{
@@ -298,27 +298,33 @@
"name": "createPod",
"params": [
{
- "description": "the ending IP address for the Pod",
+ "description": "the starting IP address for the Pod",
"length": 255,
- "name": "endip",
+ "name": "startip",
"required": false,
"type": "string"
},
{
- "description": "the Zone ID in which the Pod will be created",
+ "description": "the gateway for the Pod",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": true,
- "type": "uuid"
+ "name": "gateway",
+ "required": false,
+ "type": "string"
},
{
- "description": "the starting IP address for the Pod",
+ "description": "Allocation state of this Pod for allocation of new resources",
"length": 255,
- "name": "startip",
+ "name": "allocationstate",
"required": false,
"type": "string"
},
+ {
+ "description": "the name of the Pod",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
{
"description": "the netmask for the Pod",
"length": 255,
@@ -327,71 +333,138 @@
"type": "string"
},
{
- "description": "the gateway for the Pod",
+ "description": "the Zone ID in which the Pod will be created",
"length": 255,
- "name": "gateway",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the ending IP address for the Pod",
+ "length": 255,
+ "name": "endip",
"required": false,
"type": "string"
+ }
+ ],
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "response": [
+ {
+ "description": "the Zone name of the Pod",
+ "name": "zonename",
+ "type": "string"
},
{
- "description": "Allocation state of this Pod for allocation of new resources",
- "length": 255,
+ "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
+ "name": "startip",
+ "type": "list"
+ },
+ {
+ "description": "the allocation state of the Pod",
"name": "allocationstate",
- "required": false,
"type": "string"
},
{
"description": "the name of the Pod",
- "length": 255,
"name": "name",
- "required": true,
"type": "string"
- }
- ],
- "related": "listPods,updatePod,createManagementNetworkIpRange",
- "response": [
+ },
{
- "description": "the capacity of the Pod",
- "name": "capacity",
+ "description": "the ID of the Pod",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.",
+ "name": "endip",
+ "type": "list"
+ },
+ {
+ "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.",
+ "name": "forsystemvms",
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the Zone ID of the Pod",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the IP ranges for the Pod",
+ "name": "ipranges",
"response": [
{
- "description": "the capacity type",
- "name": "type",
- "type": "short"
+ "description": "indicates Vlan ID for the range",
+ "name": "vlanid",
+ "type": "string"
},
{
- "description": "the percentage of capacity currently in use",
- "name": "percentused",
+ "description": "the starting IP for the range",
+ "name": "startip",
"type": "string"
},
{
- "description": "the Zone name",
- "name": "zonename",
+ "description": "the CIDR for the range",
+ "name": "cidr",
"type": "string"
},
{
- "description": "the total capacity available",
- "name": "capacitytotal",
- "type": "long"
+ "description": "the ending IP for the range",
+ "name": "endip",
+ "type": "string"
},
{
- "description": "the Pod ID",
- "name": "podid",
+ "description": "indicates if range is dedicated for CPVM and SSVM",
+ "name": "forsystemvms",
"type": "string"
},
{
- "description": "the Pod name",
- "name": "podname",
+ "description": "the gateway for the range",
+ "name": "gateway",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the capacity of the Pod",
+ "name": "capacity",
+ "response": [
+ {
+ "description": "the Cluster name",
+ "name": "clustername",
"type": "string"
},
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
{
"description": "the capacity currently in allocated",
"name": "capacityallocated",
"type": "long"
},
{
- "description": "the Cluster ID",
- "name": "clusterid",
+ "description": "the capacity type",
+ "name": "type",
+ "type": "short"
+ },
+ {
+ "description": "the Zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the percentage of capacity currently in use",
+ "name": "percentused",
"type": "string"
},
{
@@ -399,19 +472,29 @@
"name": "name",
"type": "string"
},
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID",
+ "name": "zoneid",
+ "type": "string"
+ },
{
"description": "the capacity currently in use",
"name": "capacityused",
"type": "long"
},
{
- "description": "the Zone ID",
- "name": "zoneid",
+ "description": "the Pod ID",
+ "name": "podid",
"type": "string"
},
{
- "description": "the Cluster name",
- "name": "clustername",
+ "description": "the Pod name",
+ "name": "podname",
"type": "string"
}
],
@@ -427,105 +510,22 @@
"name": "jobstatus",
"type": "integer"
},
- {
- "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.",
- "name": "vlanid",
- "type": "list"
- },
- {
- "description": "the ID of the Pod",
- "name": "id",
- "type": "string"
- },
{
"description": "the gateway of the Pod",
"name": "gateway",
"type": "string"
},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{
"description": "the netmask of the Pod",
"name": "netmask",
"type": "string"
},
+ {},
{
- "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.",
- "name": "forsystemvms",
- "type": "list"
- },
- {
- "description": "the Zone name of the Pod",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.",
- "name": "endip",
- "type": "list"
- },
- {
- "description": "the allocation state of the Pod",
- "name": "allocationstate",
- "type": "string"
- },
- {
- "description": "the name of the Pod",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
- "name": "startip",
- "type": "list"
- },
- {
- "description": "the Zone ID of the Pod",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the IP ranges for the Pod",
- "name": "ipranges",
- "response": [
- {
- "description": "the gateway for the range",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the CIDR for the range",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the starting IP for the range",
- "name": "startip",
- "type": "string"
- },
- {
- "description": "indicates Vlan ID for the range",
- "name": "vlanid",
- "type": "string"
- },
- {
- "description": "the ending IP for the range",
- "name": "endip",
- "type": "string"
- },
- {
- "description": "indicates if range is dedicated for CPVM and SSVM",
- "name": "forsystemvms",
- "type": "string"
- }
- ],
+ "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.",
+ "name": "vlanid",
"type": "list"
- },
- {},
- {}
+ }
]
},
{
@@ -533,6 +533,14 @@
"isasync": false,
"name": "ldapCreateAccount",
"params": [
+ {
+ "description": "Creates the account under the specified role.",
+ "length": 255,
+ "name": "roleid",
+ "related": "createRole,importRole,listRoles,updateRole",
+ "required": false,
+ "type": "uuid"
+ },
{
"description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
"length": 255,
@@ -541,26 +549,26 @@
"type": "string"
},
{
- "description": "Account UUID, required for adding account from external provisioning system",
+ "description": "Creates the user under the specified domain.",
"length": 255,
- "name": "accountid",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "Network domain for the account's networks",
+ "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
"length": 255,
- "name": "networkdomain",
+ "name": "account",
"required": false,
"type": "string"
},
{
- "description": "Creates the account under the specified role.",
+ "description": "Network domain for the account's networks",
"length": 255,
- "name": "roleid",
- "related": "createRole,importRole,listRoles,updateRole",
+ "name": "networkdomain",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "details for account used to store specific parameters",
@@ -569,13 +577,6 @@
"required": false,
"type": "map"
},
- {
- "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
- "length": 255,
- "name": "accounttype",
- "required": false,
- "type": "integer"
- },
{
"description": "Unique username.",
"length": 255,
@@ -584,19 +585,18 @@
"type": "string"
},
{
- "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
+ "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
"length": 255,
- "name": "account",
+ "name": "accounttype",
"required": false,
- "type": "string"
+ "type": "integer"
},
{
- "description": "Creates the user under the specified domain.",
+ "description": "Account UUID, required for adding account from external provisioning system",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain",
+ "name": "accountid",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "User UUID, required for adding account from external provisioning system",
@@ -608,41 +608,25 @@
],
"related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts",
"response": [
- {},
- {
- "description": "the total secondary storage space (in GiB) owned by account",
- "name": "secondarystoragetotal",
- "type": "float"
- },
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the total number of public ip addresses available for this account to acquire",
+ "name": "ipavailable",
"type": "string"
},
{
- "description": "the name of the role",
- "name": "rolename",
+ "description": "the total number of projects available for administration by this account",
+ "name": "projectavailable",
"type": "string"
},
{
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the total secondary storage space (in GiB) available to be used for this account",
- "name": "secondarystorageavailable",
+ "description": "the total memory (in MB) available to be created for this account",
+ "name": "memoryavailable",
"type": "string"
},
{
- "description": "the total number of public ip addresses allocated for this account",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the total number of snapshots stored by this account",
- "name": "snapshottotal",
- "type": "long"
+ "description": "the id of the account",
+ "name": "id",
+ "type": "string"
},
{
"description": "the total secondary storage space (in GiB) the account can own",
@@ -650,284 +634,150 @@
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the total number of virtual machines that can be deployed by this account",
- "name": "vmlimit",
- "type": "string"
+ "description": "the total number of vpcs owned by account",
+ "name": "vpctotal",
+ "type": "long"
},
{
- "description": "the total number of networks available to be created for this account",
- "name": "networkavailable",
+ "description": "the name of the role",
+ "name": "rolename",
"type": "string"
},
{
- "description": "the total number of vpcs the account can own",
- "name": "vpclimit",
- "type": "string"
+ "description": "account type (admin, domain-admin, user)",
+ "name": "accounttype",
+ "type": "integer"
},
{
- "description": "the date when this account was created",
- "name": "created",
- "type": "date"
+ "description": "the total number of virtual machines stopped for this account",
+ "name": "vmstopped",
+ "type": "integer"
},
{
- "description": "the default zone of the account",
- "name": "defaultzoneid",
+ "description": "the total number of vpcs available to be created for this account",
+ "name": "vpcavailable",
"type": "string"
},
{
- "description": "the total number of virtual machines available for this account to acquire",
- "name": "vmavailable",
- "type": "string"
+ "description": "the total secondary storage space (in GiB) owned by account",
+ "name": "secondarystoragetotal",
+ "type": "float"
},
{
- "description": "the id of the account",
- "name": "id",
+ "description": "the total primary storage space (in GiB) available to be used for this account",
+ "name": "primarystorageavailable",
"type": "string"
},
{
- "description": "the total number of virtual machines stopped for this account",
- "name": "vmstopped",
- "type": "integer"
- },
- {
- "description": "the total number of virtual machines running for this account",
- "name": "vmrunning",
- "type": "integer"
- },
- {
- "description": "the total number of snapshots available for this account",
- "name": "snapshotavailable",
- "type": "string"
+ "description": "true if the account requires cleanup",
+ "name": "iscleanuprequired",
+ "type": "boolean"
},
{
"description": "id of the Domain the account belongs to",
"name": "domainid",
"type": "string"
},
- {},
{
- "description": "the total number of cpu cores the account can own",
- "name": "cpulimit",
+ "description": "the total number of virtual machines available for this account to acquire",
+ "name": "vmavailable",
"type": "string"
},
{
- "description": "the total number of projects the account can own",
- "name": "projectlimit",
+ "description": "the total number of templates which can be created by this account",
+ "name": "templatelimit",
"type": "string"
},
{
- "description": "the list of acl groups that account belongs to",
- "name": "groups",
- "type": "list"
- },
- {
- "description": "the total primary storage space (in GiB) owned by account",
- "name": "primarystoragetotal",
- "type": "long"
- },
- {
- "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
- "name": "roletype",
+ "description": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
"type": "string"
},
{
- "description": "the total number of snapshots which can be stored by this account",
- "name": "snapshotlimit",
+ "description": "the total number of cpu cores the account can own",
+ "name": "cpulimit",
"type": "string"
},
+ {},
{
"description": "the total memory (in MB) the account can own",
"name": "memorylimit",
"type": "string"
},
+ {},
{
- "description": "true if the account requires cleanup",
- "name": "iscleanuprequired",
- "type": "boolean"
- },
- {
- "description": "the total number of networks owned by account",
- "name": "networktotal",
- "type": "long"
- },
- {
- "description": "the name of the account",
- "name": "name",
+ "description": "the total primary storage space (in GiB) the account can own",
+ "name": "primarystoragelimit",
"type": "string"
},
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
{
"description": "the state of the account",
"name": "state",
"type": "string"
},
{
- "description": "name of the Domain the account belongs to",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "details for the account",
- "name": "accountdetails",
- "type": "map"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the total number of public ip addresses this account can acquire",
- "name": "iplimit",
- "type": "string"
+ "description": "true if account is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
},
{
- "description": "the total primary storage space (in GiB) available to be used for this account",
- "name": "primarystorageavailable",
+ "description": "the total number of networks available to be created for this account",
+ "name": "networkavailable",
"type": "string"
},
{
- "description": "account type (admin, domain-admin, user)",
- "name": "accounttype",
- "type": "integer"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
},
{
- "description": "the total volume which can be used by this account",
- "name": "volumelimit",
+ "description": "the name of the account",
+ "name": "name",
"type": "string"
},
{
- "description": "the total number of vpcs available to be created for this account",
- "name": "vpcavailable",
+ "description": "the total number of vpcs the account can own",
+ "name": "vpclimit",
"type": "string"
},
{
- "description": "the total number of virtual machines deployed by this account",
- "name": "vmtotal",
- "type": "long"
- },
- {
- "description": "the total volume being used by this account",
- "name": "volumetotal",
+ "description": "the total number of snapshots stored by this account",
+ "name": "snapshottotal",
"type": "long"
},
- {
- "description": "the total number of projects available for administration by this account",
- "name": "projectavailable",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) available to be created for this account",
- "name": "memoryavailable",
- "type": "string"
- },
{
"description": "the total number of projects being administrated by this account",
"name": "projecttotal",
"type": "long"
},
{
- "description": "the total number of cpu cores owned by account",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "path of the Domain the account belongs to",
- "name": "domainpath",
- "type": "string"
- },
- {
- "description": "the total number of networks the account can own",
- "name": "networklimit",
- "type": "string"
- },
- {
- "description": "the total number of vpcs owned by account",
- "name": "vpctotal",
- "type": "long"
- },
- {
- "description": "the total number of cpu cores available to be created for this account",
- "name": "cpuavailable",
- "type": "string"
- },
- {
- "description": "the network domain",
- "name": "networkdomain",
- "type": "string"
- },
- {
- "description": "the total number of public ip addresses available for this account to acquire",
- "name": "ipavailable",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) owned by account",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total volume available for this account",
- "name": "volumeavailable",
- "type": "string"
- },
- {
- "description": "the total number of templates available to be created by this account",
- "name": "templateavailable",
+ "description": "the total secondary storage space (in GiB) available to be used for this account",
+ "name": "secondarystorageavailable",
"type": "string"
},
{
- "description": "the ID of the role",
- "name": "roleid",
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
"type": "string"
},
{
- "description": "the total number of templates which have been created by this account",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "true if account is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the total number of templates which can be created by this account",
- "name": "templatelimit",
- "type": "string"
+ "description": "the total number of virtual machines running for this account",
+ "name": "vmrunning",
+ "type": "integer"
},
{
"description": "the list of users associated with account",
"name": "user",
"response": [
- {
- "description": "the user firstname",
- "name": "firstname",
- "type": "string"
- },
{
"description": "the date and time the user account was created",
"name": "created",
"type": "date"
},
{
- "description": "the account ID of the user",
- "name": "accountid",
- "type": "string"
- },
- {
- "description": "the type of the role",
- "name": "roletype",
- "type": "string"
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "integer"
},
{
"description": "the name of the role",
@@ -935,18 +785,18 @@
"type": "string"
},
{
- "description": "the user state",
- "name": "state",
- "type": "string"
+ "description": "the boolean value representing if the updating target is in caller's child domain",
+ "name": "iscallerchilddomain",
+ "type": "boolean"
},
{
- "description": "the timezone user was created in",
- "name": "timezone",
+ "description": "the domain ID of the user",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the user lastname",
- "name": "lastname",
+ "description": "the user name",
+ "name": "username",
"type": "string"
},
{
@@ -954,49 +804,39 @@
"name": "account",
"type": "string"
},
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the source type of the user in lowercase, such as native, ldap, saml2",
- "name": "usersource",
- "type": "string"
- },
{
"description": "the domain name of the user",
"name": "domain",
"type": "string"
},
{
- "description": "the ID of the role",
- "name": "roleid",
+ "description": "the timezone user was created in",
+ "name": "timezone",
"type": "string"
},
{
- "description": "the boolean value representing if the updating target is in caller's child domain",
- "name": "iscallerchilddomain",
+ "description": "true if user has two factor authentication enabled",
+ "name": "is2faenabled",
"type": "boolean"
},
{
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
+ "description": "the api key of the user",
+ "name": "apikey",
+ "type": "string"
},
{
- "description": "the user email address",
- "name": "email",
+ "description": "the secret key of the user",
+ "name": "secretkey",
"type": "string"
},
{
- "description": "the user ID",
- "name": "id",
+ "description": "the user state",
+ "name": "state",
"type": "string"
},
{
- "description": "the secret key of the user",
- "name": "secretkey",
+ "description": "the user firstname",
+ "name": "firstname",
"type": "string"
},
{
@@ -1005,151 +845,335 @@
"type": "boolean"
},
{
- "description": "the api key of the user",
- "name": "apikey",
+ "description": "the user lastname",
+ "name": "lastname",
"type": "string"
},
{
- "description": "true if user has two factor authentication enabled",
- "name": "is2faenabled",
+ "description": "the type of the role",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the source type of the user in lowercase, such as native, ldap, saml2",
+ "name": "usersource",
+ "type": "string"
+ },
+ {
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
"type": "boolean"
},
{
- "description": "the user name",
- "name": "username",
+ "description": "the user ID",
+ "name": "id",
"type": "string"
},
{
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "integer"
+ "description": "the account ID of the user",
+ "name": "accountid",
+ "type": "string"
},
{
- "description": "the domain ID of the user",
- "name": "domainid",
+ "description": "the ID of the role",
+ "name": "roleid",
"type": "string"
}
],
"type": "list"
},
{
- "description": "the total primary storage space (in GiB) the account can own",
- "name": "primarystoragelimit",
- "type": "string"
- }
- ],
- "since": "4.2.0"
- },
- {
- "description": "Safely removes raw records from cloud_usage table",
- "isasync": false,
- "name": "removeRawUsageRecords",
- "params": [
- {
- "description": "Specify the number of days (greater than zero) to remove records that are older than those number of days from today. For example, specifying 10 would result in removing all the records created before 10 days from today",
- "length": 255,
- "name": "interval",
- "required": true,
- "type": "integer"
- }
- ],
- "response": [
+ "description": "the list of acl groups that account belongs to",
+ "name": "groups",
+ "type": "list"
+ },
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "the total number of public ip addresses allocated for this account",
+ "name": "iptotal",
+ "type": "long"
},
- {},
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the total number of snapshots available for this account",
+ "name": "snapshotavailable",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the total memory (in MB) owned by account",
+ "name": "memorytotal",
+ "type": "long"
},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- }
- ],
- "since": "4.6.0"
- },
- {
- "description": "Copies an iso from one zone to another.",
- "isasync": true,
- "name": "copyIso",
- "params": [
- {
- "description": "ID of the zone the template is being copied to.",
- "length": 255,
- "name": "destzoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
+ "description": "the date when this account was created",
+ "name": "created",
+ "type": "date"
},
{
- "description": "Template ID.",
- "length": 255,
- "name": "id",
- "related": "prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
- "required": true,
- "type": "uuid"
+ "description": "the total volume being used by this account",
+ "name": "volumetotal",
+ "type": "long"
},
{
- "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.",
- "length": 255,
- "name": "destzoneids",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "list"
+ "description": "the total number of projects the account can own",
+ "name": "projectlimit",
+ "type": "string"
},
{
- "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.",
- "length": 255,
- "name": "sourcezoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
- }
- ],
- "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
- "response": [
- {
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
+ "description": "the total number of cpu cores available to be created for this account",
+ "name": "cpuavailable",
+ "type": "string"
},
{
- "description": "the name of the OS type for this template.",
- "name": "ostypename",
+ "description": "the ID of the role",
+ "name": "roleid",
"type": "string"
},
{
- "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata",
- "name": "userdataparams",
- "type": "string"
+ "description": "the total number of cpu cores owned by account",
+ "name": "cputotal",
+ "type": "long"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "the total number of networks owned by account",
+ "name": "networktotal",
+ "type": "long"
+ },
+ {
+ "description": "the total volume which can be used by this account",
+ "name": "volumelimit",
"type": "string"
},
{
- "description": "the name of userdata linked to this template",
- "name": "userdataname",
+ "description": "name of the Domain the account belongs to",
+ "name": "domain",
"type": "string"
},
- {},
+ {
+ "description": "details for the account",
+ "name": "accountdetails",
+ "type": "map"
+ },
+ {
+ "description": "the total number of virtual machines deployed by this account",
+ "name": "vmtotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of networks the account can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the default zone of the account",
+ "name": "defaultzoneid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "path of the Domain the account belongs to",
+ "name": "domainpath",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which have been created by this account",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the total primary storage space (in GiB) owned by account",
+ "name": "primarystoragetotal",
+ "type": "long"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates available to be created by this account",
+ "name": "templateavailable",
+ "type": "string"
+ }
+ ],
+ "since": "4.2.0"
+ },
+ {
+ "description": "Safely removes raw records from cloud_usage table",
+ "isasync": false,
+ "name": "removeRawUsageRecords",
+ "params": [
+ {
+ "description": "Specify the number of days (greater than zero) to remove records that are older than those number of days from today. For example, specifying 10 would result in removing all the records created before 10 days from today",
+ "length": 255,
+ "name": "interval",
+ "required": true,
+ "type": "integer"
+ }
+ ],
+ "response": [
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {}
+ ],
+ "since": "4.6.0"
+ },
+ {
+ "description": "Copies an iso from one zone to another.",
+ "isasync": true,
+ "name": "copyIso",
+ "params": [
+ {
+ "description": "Template ID.",
+ "length": 255,
+ "name": "id",
+ "related": "prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.",
+ "length": 255,
+ "name": "sourcezoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "ID of the zone the template is being copied to.",
+ "length": 255,
+ "name": "destzoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.",
+ "length": 255,
+ "name": "destzoneids",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "list"
+ }
+ ],
+ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
+ "response": [
+ {
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
+ "name": "deployasis",
+ "type": "boolean"
+ },
+ {
+ "description": "if root disk template, then ids of the datas disk templates this template owns",
+ "name": "childtemplates",
+ "type": "set"
+ },
+ {
+ "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata",
+ "name": "userdataparams",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the template",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the format of the template.",
+ "name": "format",
+ "type": "imageformat"
+ },
{
"description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
"name": "directdownload",
"type": "boolean"
},
+ {
+ "description": "the processor bit size",
+ "name": "bits",
+ "type": "int"
+ },
+ {
+ "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "the template ID of the parent template if present",
+ "name": "sourcetemplateid",
+ "type": "string"
+ },
+ {
+ "description": "the tag of this template",
+ "name": "templatetag",
+ "type": "string"
+ },
{
"description": "the list of resource tags associated",
"name": "tags",
@@ -1160,8 +1184,8 @@
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
@@ -1170,8 +1194,8 @@
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -1180,8 +1204,8 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
@@ -1190,13 +1214,13 @@
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
@@ -1208,29 +1232,29 @@
"type": "set"
},
{
- "description": "the account name to which the template belongs",
- "name": "account",
+ "description": "the account id to which the template belongs",
+ "name": "accountid",
"type": "string"
},
{
- "description": "the project id of the template",
- "name": "projectid",
- "type": "string"
+ "description": "true if the reset password feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
},
{
- "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
- "name": "isdynamicallyscalable",
+ "description": "true if the template is extractable, false otherwise",
+ "name": "isextractable",
"type": "boolean"
},
{
- "description": "the physical size of the template",
- "name": "physicalsize",
- "type": "long"
+ "description": "the type of the template",
+ "name": "templatetype",
+ "type": "string"
},
{
- "description": "the ID of the zone for this template",
- "name": "zoneid",
- "type": "string"
+ "description": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
},
{
"description": "true if this template is a public template, false otherwise",
@@ -1238,24 +1262,24 @@
"type": "boolean"
},
{
- "description": "true if the template is ready to be deployed from, false otherwise.",
- "name": "isready",
- "type": "boolean"
+ "description": "if Datadisk template, then id of the root disk template this template belongs to",
+ "name": "parenttemplateid",
+ "type": "string"
},
{
- "description": "additional key/value details tied with template",
- "name": "details",
- "type": "map"
+ "description": "the name of userdata linked to this template",
+ "name": "userdataname",
+ "type": "string"
},
{
- "description": "the processor bit size",
- "name": "bits",
- "type": "int"
+ "description": "the name of the secondary storage host for the template",
+ "name": "hostname",
+ "type": "string"
},
{
- "description": "the date this template was removed",
- "name": "removed",
- "type": "date"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
},
{
"description": "true if template requires HVM enabled, false otherwise",
@@ -1263,49 +1287,51 @@
"type": "boolean"
},
{
- "description": "true if template is sshkey enabled, false otherwise",
- "name": "sshkeyenabled",
- "type": "boolean"
- },
- {
- "description": "the name of the domain to which the template belongs",
- "name": "domain",
+ "description": "the URL which the template/iso is registered from",
+ "name": "url",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
},
+ {},
{
- "description": "the ID of the secondary storage host for the template",
- "name": "hostid",
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
"type": "string"
},
{
- "description": "the name of the secondary storage host for the template",
- "name": "hostname",
+ "description": "the status of the template",
+ "name": "status",
"type": "string"
},
{
- "description": "the userdata override policy with the userdata provided while deploying VM",
- "name": "userdatapolicy",
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "true if the template is managed across all Zones, false otherwise",
+ "name": "crossZones",
+ "type": "boolean"
},
{
- "description": "the account id to which the template belongs",
- "name": "accountid",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the template ID",
+ "name": "id",
"type": "string"
},
+ {},
{
- "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
- "name": "deployasis",
- "type": "boolean"
+ "description": "checksum of the template",
+ "name": "checksum",
+ "type": "string"
},
{
"description": "VMware only: additional key/value details tied with deploy-as-is template",
@@ -1313,33 +1339,38 @@
"type": "map"
},
{
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
+ "description": "the template display text",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "true if this template is a featured template, false otherwise",
+ "name": "isfeatured",
"type": "boolean"
},
{
- "description": "the template ID of the parent template if present",
- "name": "sourcetemplateid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the size of the template",
- "name": "size",
- "type": "long"
+ "description": "true if template is sshkey enabled, false otherwise",
+ "name": "sshkeyenabled",
+ "type": "boolean"
},
{
- "description": "the project name of the template",
- "name": "project",
- "type": "string"
+ "description": "additional key/value details tied with template",
+ "name": "details",
+ "type": "map"
},
{
- "description": "the ID of the OS type for this template.",
- "name": "ostypeid",
+ "description": "the name of the zone for this template",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the id of userdata linked to this template",
- "name": "userdataid",
+ "description": "the account name to which the template belongs",
+ "name": "account",
"type": "string"
},
{
@@ -1348,101 +1379,109 @@
"type": "string"
},
{
- "description": "the name of the zone for this template",
- "name": "zonename",
- "type": "string"
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
},
{
- "description": "if Datadisk template, then id of the root disk template this template belongs to",
- "name": "parenttemplateid",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "true if the ISO is bootable, false otherwise",
- "name": "bootable",
- "type": "boolean"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the ID of the secondary storage host for the template",
+ "name": "hostid",
+ "type": "string"
},
{
- "description": "the format of the template.",
- "name": "format",
- "type": "imageformat"
+ "description": "the userdata override policy with the userdata provided while deploying VM",
+ "name": "userdatapolicy",
+ "type": "string"
},
{
- "description": "the type of the template",
- "name": "templatetype",
- "type": "string"
+ "description": "true if the template is ready to be deployed from, false otherwise.",
+ "name": "isready",
+ "type": "boolean"
},
{
- "description": "the status of the template",
- "name": "status",
- "type": "string"
+ "description": "true if the ISO is bootable, false otherwise",
+ "name": "bootable",
+ "type": "boolean"
},
{
- "description": "the tag of this template",
- "name": "templatetag",
+ "description": "the ID of the zone for this template",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the date this template was created",
- "name": "created",
- "type": "date"
+ "description": "the size of the template",
+ "name": "size",
+ "type": "long"
},
{
- "description": "checksum of the template",
- "name": "checksum",
+ "description": "the id of userdata linked to this template",
+ "name": "userdataid",
"type": "string"
},
{
- "description": "Lists the download progress of a template across all secondary storages",
- "name": "downloaddetails",
- "type": "list"
- },
- {
- "description": "the template display text",
- "name": "displaytext",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "true if the template is managed across all Zones, false otherwise",
- "name": "crossZones",
- "type": "boolean"
+ "description": "the project id of the template",
+ "name": "projectid",
+ "type": "string"
},
- {},
{
- "description": "the URL which the template/iso is registered from",
- "name": "url",
+ "description": "the name of the domain to which the template belongs",
+ "name": "domain",
"type": "string"
},
{
- "description": "the template ID",
+ "description": "the physical size of the template",
+ "name": "physicalsize",
+ "type": "long"
+ }
+ ]
+ },
+ {
+ "description": "Deletes a autoscale vm profile.",
+ "isasync": true,
+ "name": "deleteAutoScaleVmProfile",
+ "params": [
+ {
+ "description": "the ID of the autoscale profile",
+ "length": 255,
"name": "id",
+ "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "response": [
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "true if this template is a featured template, false otherwise",
- "name": "isfeatured",
- "type": "boolean"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
},
{
- "description": "true if the template is extractable, false otherwise",
- "name": "isextractable",
+ "description": "true if operation is executed successfully",
+ "name": "success",
"type": "boolean"
},
+ {},
{
- "description": "if root disk template, then ids of the datas disk templates this template owns",
- "name": "childtemplates",
- "type": "set"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
- {
- "description": "the ID of the domain to which the template belongs",
- "name": "domainid",
- "type": "string"
- }
+ {}
]
},
{
@@ -1454,89 +1493,50 @@
"description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)",
"length": 255,
"name": "hostid",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost",
"required": true,
"type": "uuid"
},
{
- "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used",
+ "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used",
"length": 255,
- "name": "reconnect",
+ "name": "provider",
"required": false,
- "type": "boolean"
+ "type": "string"
},
{
- "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used",
+ "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used",
"length": 255,
- "name": "provider",
+ "name": "reconnect",
"required": false,
- "type": "string"
+ "type": "boolean"
}
],
"response": [
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
- {},
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
- {}
- ],
- "since": "4.11.0"
- },
- {
- "description": "Deletes a autoscale vm profile.",
- "isasync": true,
- "name": "deleteAutoScaleVmProfile",
- "params": [
- {
- "description": "the ID of the autoscale profile",
- "length": 255,
- "name": "id",
- "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile",
- "required": true,
- "type": "uuid"
- }
- ],
- "response": [
{},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
}
- ]
+ ],
+ "since": "4.11.0"
},
{
"description": "Lists VM metrics",
@@ -1544,34 +1544,35 @@
"name": "listVirtualMachinesMetrics",
"params": [
{
- "description": "list vms by iso",
+ "description": "the group ID",
"length": 255,
- "name": "isoid",
+ "name": "groupid",
+ "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup",
"required": false,
"type": "uuid"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain",
+ "name": "accumulate",
"required": false,
- "type": "uuid"
+ "since": "4.17.0",
+ "type": "boolean"
},
{
- "description": "list resources by account. Must be used with the domainId parameter.",
+ "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled",
"length": 255,
- "name": "account",
+ "name": "haenable",
"required": false,
- "type": "string"
+ "since": "4.15",
+ "type": "boolean"
},
{
- "description": "the storage ID where vm's volumes belong to",
+ "description": "List by keyword",
"length": 255,
- "name": "storageid",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools",
+ "name": "keyword",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "the user ID that created the VM and is under the account that owns the VM",
@@ -1582,250 +1583,257 @@
"type": "uuid"
},
{
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "description": "the IDs of the virtual machines, mutually exclusive with id",
"length": 255,
- "name": "displayvm",
+ "name": "ids",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtua [...]
"required": false,
"since": "4.4",
- "type": "boolean"
+ "type": "list"
},
{
- "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)",
+ "description": "",
"length": 255,
- "name": "name",
+ "name": "page",
"required": false,
- "type": "string"
+ "type": "integer"
},
{
- "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.",
+ "description": "the host ID",
"length": 255,
- "name": "userdata",
+ "name": "hostid",
+ "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost",
"required": false,
- "since": "4.18.0.0",
- "type": "boolean"
+ "type": "uuid"
},
{
- "description": "the IDs of the virtual machines, mutually exclusive with id",
+ "description": "the security group ID",
"length": 255,
- "name": "ids",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtua [...]
+ "name": "securitygroupid",
+ "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup",
"required": false,
- "since": "4.4",
- "type": "list"
+ "since": "4.15",
+ "type": "uuid"
},
{
- "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all",
+ "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.",
"length": 255,
- "name": "details",
+ "name": "isvnf",
"required": false,
- "type": "list"
+ "since": "4.19.0",
+ "type": "boolean"
},
{
- "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.",
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
"length": 255,
- "name": "isvnf",
+ "name": "displayvm",
"required": false,
- "since": "4.19.0",
+ "since": "4.4",
"type": "boolean"
},
{
- "description": "list by the backup offering",
+ "description": "List resources by tags (key/value pairs)",
"length": 255,
- "name": "backupofferingid",
+ "name": "tags",
"required": false,
- "since": "4.17",
- "type": "uuid"
+ "type": "map"
},
{
- "description": "list vms by template",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "templateid",
- "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
+ "name": "account",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.",
+ "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.",
"length": 255,
- "name": "listall",
+ "name": "userdata",
"required": false,
+ "since": "4.18.0.0",
"type": "boolean"
},
{
- "description": "list objects by project; if projectid=-1 lists All VMs",
+ "description": "makes the API's response contains only the resource count",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "name": "retrieveonlyresourcecount",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list by network id",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
"type": "uuid"
},
{
- "description": "flag to display the resource icon for VMs",
+ "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all",
"length": 255,
- "name": "showicon",
+ "name": "details",
"required": false,
- "since": "4.16.0.0",
- "type": "boolean"
+ "type": "list"
},
{
- "description": "the security group ID",
+ "description": "list vms by iso",
"length": 255,
- "name": "securitygroupid",
- "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup",
+ "name": "isoid",
"required": false,
- "since": "4.15",
"type": "uuid"
},
{
- "description": "list by network type; true if need to list vms using Virtual Network, false otherwise",
+ "description": "list vms by vpc",
"length": 255,
- "name": "forvirtualnetwork",
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
"required": false,
- "type": "boolean"
+ "type": "uuid"
},
{
- "description": "",
+ "description": "the target hypervisor for the template",
"length": 255,
- "name": "page",
+ "name": "hypervisor",
"required": false,
- "type": "integer"
+ "type": "string"
},
{
- "description": "the group ID",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "groupid",
- "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain",
"required": false,
"type": "uuid"
},
{
- "description": "List resources by tags (key/value pairs)",
+ "description": "the ID of the virtual machine",
"length": 255,
- "name": "tags",
+ "name": "id",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtua [...]
"required": false,
- "type": "map"
+ "type": "uuid"
},
{
- "description": "the host ID",
+ "description": "list objects by project; if projectid=-1 lists All VMs",
"length": 255,
- "name": "hostid",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
{
- "description": "",
+ "description": "the cluster ID",
"length": 255,
- "name": "pagesize",
+ "name": "clusterid",
+ "related": "addCluster,listClusters,updateCluster",
"required": false,
- "type": "integer"
+ "type": "uuid"
},
{
- "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.",
+ "description": "list vms by ssh keypair name",
"length": 255,
- "name": "state",
+ "name": "keypair",
"required": false,
"type": "string"
},
{
- "description": "list vms by vpc",
+ "description": "list vms by template",
"length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
+ "name": "templateid",
+ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
"required": false,
"type": "uuid"
},
{
- "description": "the ID of the virtual machine",
+ "description": "list by the backup offering",
"length": 255,
- "name": "id",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtua [...]
+ "name": "backupofferingid",
"required": false,
+ "since": "4.17",
"type": "uuid"
},
{
- "description": "list vms by ssh keypair name",
+ "description": "the ID of AutoScaling VM Group",
"length": 255,
- "name": "keypair",
+ "name": "autoscalevmgroupid",
+ "related": "createAutoScaleVmGroup,disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup",
"required": false,
- "type": "string"
+ "since": "4.18.0",
+ "type": "uuid"
},
{
- "description": "the target hypervisor for the template",
+ "description": "the pod ID",
"length": 255,
- "name": "hypervisor",
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.",
"length": 255,
- "name": "isrecursive",
+ "name": "listall",
"required": false,
"type": "boolean"
},
{
- "description": "makes the API's response contains only the resource count",
+ "description": "",
"length": 255,
- "name": "retrieveonlyresourcecount",
+ "name": "pagesize",
"required": false,
- "type": "boolean"
+ "type": "integer"
},
{
- "description": "the cluster ID",
+ "description": "list vms by affinity group",
"length": 255,
- "name": "clusterid",
- "related": "addCluster,listClusters,updateCluster",
+ "name": "affinitygroupid",
+ "related": "createAffinityGroup,listAffinityGroups",
"required": false,
"type": "uuid"
},
{
- "description": "the availability zone ID",
+ "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "name",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
- "description": "the ID of AutoScaling VM Group",
+ "description": "the storage ID where vm's volumes belong to",
"length": 255,
- "name": "autoscalevmgroupid",
- "related": "createAutoScaleVmGroup,disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup",
+ "name": "storageid",
+ "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
"required": false,
- "since": "4.18.0",
"type": "uuid"
},
{
- "description": "List by keyword",
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
- "name": "keyword",
+ "name": "isrecursive",
"required": false,
- "type": "string"
+ "type": "boolean"
},
{
- "description": "the pod ID",
+ "description": "the availability zone ID",
"length": 255,
- "name": "podid",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
"type": "uuid"
},
{
- "description": "list by network id",
+ "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.",
"length": 255,
- "name": "networkid",
- "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "name": "state",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
- "description": "list vms by affinity group",
+ "description": "list by network type; true if need to list vms using Virtual Network, false otherwise",
"length": 255,
- "name": "affinitygroupid",
- "related": "createAffinityGroup,listAffinityGroups",
+ "name": "forvirtualnetwork",
"required": false,
- "type": "uuid"
+ "type": "boolean"
},
{
"description": "list by the service offering",
@@ -1837,114 +1845,110 @@
"type": "uuid"
},
{
- "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.",
- "length": 255,
- "name": "accumulate",
- "required": false,
- "since": "4.17.0",
- "type": "boolean"
- },
- {
- "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled",
+ "description": "flag to display the resource icon for VMs",
"length": 255,
- "name": "haenable",
+ "name": "showicon",
"required": false,
- "since": "4.15",
+ "since": "4.16.0.0",
"type": "boolean"
}
],
"related": "listVirtualMachinesMetrics",
"response": [
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
- "type": "string"
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
},
{
- "description": "the total disk iops",
- "name": "diskiopstotal",
- "type": "long"
+ "description": "list of variables and values for the variables declared in userdata",
+ "name": "userdatadetails",
+ "type": "string"
},
{
- "description": "the group name of the virtual machine",
- "name": "group",
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
"type": "string"
},
{},
{
- "description": "the target memory in VM (KiB)",
- "name": "memorytargetkbs",
- "type": "long"
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
},
{
- "description": "the group ID of the virtual machine",
- "name": "groupid",
- "type": "string"
+ "description": "the VM's disk write in KiB",
+ "name": "diskkbswrite",
+ "type": "long"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
- "type": "string"
+ "description": "the VM's disk read in KiB",
+ "name": "diskkbsread",
+ "type": "long"
},
{
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
+ "description": "the read (IO) of disk on the VM",
+ "name": "diskioread",
+ "type": "long"
},
{
- "description": "the userdata override policy with the userdata provided while deploying VM",
- "name": "userdatapolicy",
+ "description": "the name of userdata used for the VM",
+ "name": "userdataname",
"type": "string"
},
{
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
"type": "string"
},
- {},
{
- "description": "device type of the root volume",
- "name": "rootdevicetype",
+ "description": "the total memory capacity in GiB",
+ "name": "memorytotal",
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
},
{
- "description": "the total memory capacity in GiB",
- "name": "memorytotal",
+ "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead",
+ "name": "diskofferingname",
"type": "string"
},
{
- "description": "the type of the template for the virtual machine",
- "name": "templatetype",
- "type": "string"
+ "description": "NICs of the VNF appliance",
+ "name": "vnfnics",
+ "type": "list"
},
{
- "description": "OS name of the vm",
- "name": "osdisplayname",
+ "description": "the memory used by the VM in KiB",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
},
{
- "description": "the project id of the vm",
- "name": "projectid",
+ "description": "Name of AutoScale VM group",
+ "name": "autoscalevmgroupname",
"type": "string"
},
{
- "description": "the pool type of the virtual machine",
- "name": "pooltype",
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
"type": "string"
},
{
@@ -1953,33 +1957,39 @@
"type": "string"
},
{
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
+ "description": "the target memory in VM (KiB)",
+ "name": "memorytargetkbs",
"type": "long"
},
+ {},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
},
{
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
"type": "string"
},
{
- "description": "the incoming network traffic on the VM in KiB",
- "name": "networkkbsread",
- "type": "long"
+ "description": "the userdata override policy with the userdata provided while deploying VM",
+ "name": "userdatapolicy",
+ "type": "string"
},
{
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
"type": "string"
},
{
@@ -1987,418 +1997,82 @@
"name": "username",
"type": "string"
},
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
{
"description": "the name of the service offering of the virtual machine",
"name": "serviceofferingname",
"type": "string"
},
{
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
"type": "string"
},
{
- "description": "the memory used by the VM in KiB",
- "name": "memorykbs",
- "type": "long"
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
},
{
- "description": "list of affinity groups associated with the virtual machine",
- "name": "affinitygroup",
- "response": [
- {
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the ID of the affinity group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the project ID of the affinity group",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the type of the affinity group",
- "name": "type",
- "type": "string"
- },
- {
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
- },
- {
- "description": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the name of the affinity group",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the project name of the affinity group",
- "name": "project",
- "type": "string"
- },
- {
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
- },
- {
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
- "type": "string"
- },
- {
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "Base64 string containing the user data",
- "name": "userdata",
- "type": "string"
- },
- {
- "description": "the read (IO) of disk on the VM",
- "name": "diskioread",
- "type": "long"
- },
- {
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the date when this virtual machine was updated last time",
- "name": "lastupdated",
- "type": "date"
- },
- {
- "description": "the id of userdata used for the VM",
- "name": "userdataid",
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
"type": "string"
},
{
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the write (IO) of disk on the VM",
- "name": "diskiowrite",
- "type": "long"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
},
{
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
"type": "boolean"
},
{
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "disk read in MiB",
- "name": "diskread",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "the outgoing network traffic on the host in KiB",
- "name": "networkkbswrite",
- "type": "long"
- },
- {
- "description": "List of read-only Vm details as comma separated string.",
- "name": "readonlydetails",
+ "description": "ssh key-pairs",
+ "name": "keypairs",
"type": "string"
},
{
- "description": "the name of the virtual machine",
- "name": "name",
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
"type": "string"
},
{
- "description": "the list of nics associated with vm",
- "name": "nic",
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
"response": [
{
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "public IP address id associated with this nic via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
- },
- {
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
- "type": "string"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the ID of the corresponding network",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
- "type": "string"
- },
- {
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "name of the vpc to which the nic belongs",
- "name": "vpcname",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "Id of the vpc to which the nic belongs",
- "name": "vpcid",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "type": "string"
- },
- {
- "description": "public IP address associated with this nic via Static nat rule",
- "name": "publicip",
- "type": "string"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
- "name": "id",
- "type": "string"
- },
- {
- "description": "MTU configured on the NIC",
- "name": "mtu",
- "type": "integer"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
- "type": "list"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
+ "description": "the domain ID of the security group",
+ "name": "domainid",
"type": "string"
},
{
- "description": "Type of adapter if available",
- "name": "adaptertype",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the total cpu capacity in Ghz",
- "name": "cputotal",
- "type": "string"
- },
- {
- "description": "list of security groups associated with the virtual machine",
- "name": "securitygroup",
- "response": [
- {
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
"response": [
{
- "description": "the ending IP of the security group rule ",
- "name": "endport",
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
"type": "integer"
},
{
- "description": "the id of the security group rule",
- "name": "ruleid",
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
"type": "string"
},
{
@@ -2407,18 +2081,23 @@
"type": "string"
},
{
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
"type": "string"
},
{
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
},
{
- "description": "the starting IP of the security group rule",
- "name": "startport",
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
"type": "integer"
},
{
@@ -2427,17 +2106,17 @@
"type": "string"
},
{
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
},
{
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -2455,24 +2134,14 @@
"name": "projectid",
"type": "string"
},
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
{
"description": "the account associated with the tag",
"name": "account",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -2484,36 +2153,26 @@
"description": "customer associated with the tag",
"name": "customer",
"type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
}
],
"type": "set"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
}
],
"type": "set"
},
{
- "description": "the description of the security group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the domain ID of the security group",
- "name": "domainid",
+ "description": "the project id of the group",
+ "name": "projectid",
"type": "string"
},
{
@@ -2522,101 +2181,29 @@
"type": "integer"
},
{
- "description": "the project name of the group",
- "name": "project",
+ "description": "the account owning the security group",
+ "name": "account",
"type": "string"
},
{
- "description": "the project id of the group",
- "name": "projectid",
+ "description": "the project name of the group",
+ "name": "project",
"type": "string"
},
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- }
- ],
- "type": "set"
- },
{
"description": "the list of virtualmachine ids associated with this securitygroup",
"name": "virtualmachineids",
"type": "set"
},
{
- "description": "the domain name of the security group",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
"response": [
{
"description": "the protocol of the security group rule",
"name": "protocol",
"type": "string"
},
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
{
"description": "the type of the ICMP message response",
"name": "icmptype",
@@ -2628,8 +2215,8 @@
"type": "integer"
},
{
- "description": "the ending IP of the security group rule ",
- "name": "endport",
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
"type": "integer"
},
{
@@ -2637,33 +2224,43 @@
"name": "account",
"type": "string"
},
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
{
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -2672,8 +2269,8 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
@@ -2682,257 +2279,667 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the id of the security group rule",
- "name": "ruleid",
+ "description": "security group name",
+ "name": "securitygroupname",
"type": "string"
},
{
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
}
],
"type": "set"
},
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
{
"description": "the name of the security group",
"name": "name",
"type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the description of the security group",
+ "name": "description",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "disk write in MiB",
- "name": "diskwrite",
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
"type": "string"
},
{
- "description": "NICs of the VNF appliance",
- "name": "vnfnics",
- "type": "list"
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
},
{
- "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead",
- "name": "diskofferingid",
- "type": "string"
+ "description": "VNF details",
+ "name": "vnfdetails",
+ "type": "map"
},
{
- "description": "list of variables and values for the variables declared in userdata",
- "name": "userdatadetails",
- "type": "string"
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
},
{
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
"type": "string"
},
{
- "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
- "name": "templateid",
+ "description": "the ID of the availability zone for the virtual machine",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
+ "description": "ID of AutoScale VM group",
+ "name": "autoscalevmgroupid",
"type": "string"
},
{
- "description": "network write in MiB",
- "name": "networkwrite",
+ "description": "the total cpu capacity in Ghz",
+ "name": "cputotal",
"type": "string"
},
{
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
+ "description": "disk write in MiB",
+ "name": "diskwrite",
"type": "string"
},
{
- "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated",
- "name": "memoryintfreekbs",
- "type": "long"
+ "description": "Base64 string containing the user data",
+ "name": "userdata",
+ "type": "string"
},
{
- "description": "VNF details",
- "name": "vnfdetails",
- "type": "map"
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
},
{
- "description": "Name of AutoScale VM group",
- "name": "autoscalevmgroupname",
- "type": "string"
+ "description": "the speed of each vCPU",
+ "name": "cpuspeed",
+ "type": "integer"
},
{
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
"type": "string"
},
{
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
+ "description": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
+ "response": [
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
},
{
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
+ "description": "network read in MiB",
+ "name": "networkread",
"type": "string"
},
{
- "description": "ID of AutoScale VM group",
- "name": "autoscalevmgroupid",
+ "description": "the type of the template for the virtual machine",
+ "name": "templatetype",
"type": "string"
},
{
- "description": "the VM's primary IP address",
- "name": "ipaddress",
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
"type": "string"
},
{
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
- },
- {
- "description": "network read in MiB",
- "name": "networkread",
+ "description": "the project id of the vm",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the account associated with the virtual machine",
- "name": "account",
+ "description": "the vGPU type used by the virtual machine",
+ "name": "vgpu",
"type": "string"
},
{
- "description": "the number of vCPUs this virtual machine is using",
- "name": "cpunumber",
- "type": "integer"
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
},
{
- "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead",
- "name": "diskofferingname",
+ "description": "the control state of the host for the virtual machine",
+ "name": "hostcontrolstate",
"type": "string"
},
{
- "description": "the ID of the virtual machine",
- "name": "id",
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
"type": "string"
},
{
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
- "type": "string"
+ "description": "the write (IO) of disk on the VM",
+ "name": "diskiowrite",
+ "type": "long"
},
{
- "description": "the name of userdata used for the VM",
- "name": "userdataname",
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
"type": "string"
},
{
- "description": "the project name of the vm",
- "name": "project",
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
"type": "string"
},
{
- "description": "State of the Service from LB rule",
- "name": "servicestate",
+ "description": "the project name of the vm",
+ "name": "project",
"type": "string"
},
+ {},
{
- "description": "the VM's disk write in KiB",
- "name": "diskkbswrite",
- "type": "long"
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
},
{
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the speed of each vCPU",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "Guest vm Boot Type",
- "name": "boottype",
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
"type": "string"
},
{
- "description": "the control state of the host for the virtual machine",
- "name": "hostcontrolstate",
+ "description": "the name of the virtual machine",
+ "name": "name",
"type": "string"
},
{
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
- "type": "integer"
+ "description": "the incoming network traffic on the VM in KiB",
+ "name": "networkkbsread",
+ "type": "long"
},
{
- "description": "the vGPU type used by the virtual machine",
- "name": "vgpu",
- "type": "string"
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "name of the vpc to which the nic belongs",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vpc to which the nic belongs",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "public IP address associated with this nic via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "MTU configured on the NIC",
+ "name": "mtu",
+ "type": "integer"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with this nic via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ }
+ ],
+ "type": "set"
},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
},
- {},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
+ "description": "the total disk iops",
+ "name": "diskiopstotal",
+ "type": "long"
},
{
- "description": "the ID of the availability zone for the virtual machine",
- "name": "zoneid",
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
"type": "string"
},
{
- "description": "the VM's disk read in KiB",
- "name": "diskkbsread",
- "type": "long"
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
},
{
- "description": "ssh key-pairs",
- "name": "keypairs",
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
"type": "string"
},
{
- "description": "the state of the virtual machine",
- "name": "state",
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
+ "description": "network write in MiB",
+ "name": "networkwrite",
"type": "string"
- }
- ]
- },
- {
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the id of userdata used for the VM",
+ "name": "userdataid",
+ "type": "string"
+ },
+ {
+ "description": "the number of vCPUs this virtual machine is using",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host in KiB",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the VM's primary IP address",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "disk read in MiB",
+ "name": "diskread",
+ "type": "string"
+ }
+ ]
+ },
+ {
"description": "Lists hosts.",
"isasync": false,
"name": "listHosts",
"params": [
+ {
+ "description": "list hosts for which out-of-band management is enabled",
+ "length": 255,
+ "name": "outofbandmanagementenabled",
+ "required": false,
+ "type": "boolean"
+ },
{
"description": "the Zone ID for the host",
"length": 255,
@@ -2949,25 +2956,24 @@
"type": "integer"
},
{
- "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
+ "description": "the state of the host",
"length": 255,
- "name": "hypervisor",
+ "name": "state",
"required": false,
"type": "string"
},
{
- "description": "lists hosts existing in particular cluster",
+ "description": "the name of the host",
"length": 255,
- "name": "clusterid",
- "related": "addCluster,listClusters,updateCluster",
+ "name": "name",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
- "description": "the Pod ID for the host",
+ "description": "lists hosts existing in particular cluster",
"length": 255,
- "name": "podid",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "name": "clusterid",
+ "related": "addCluster,listClusters,updateCluster",
"required": false,
"type": "uuid"
},
@@ -2979,51 +2985,45 @@
"type": "boolean"
},
{
- "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
- "length": 255,
- "name": "details",
- "required": false,
- "type": "list"
- },
- {
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "page",
+ "name": "keyword",
"required": false,
- "type": "integer"
+ "type": "string"
},
{
- "description": "list hosts for which out-of-band management is enabled",
+ "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
"length": 255,
- "name": "outofbandmanagementenabled",
+ "name": "details",
"required": false,
- "type": "boolean"
+ "type": "list"
},
{
- "description": "the host type",
+ "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]",
"length": 255,
- "name": "type",
+ "name": "outofbandmanagementpowerstate",
"required": false,
"type": "string"
},
{
- "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]",
+ "description": "the Pod ID for the host",
"length": 255,
- "name": "resourcestate",
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "the state of the host",
+ "description": "",
"length": 255,
- "name": "state",
+ "name": "page",
"required": false,
- "type": "string"
+ "type": "integer"
},
{
- "description": "the name of the host",
+ "description": "the host type",
"length": 255,
- "name": "name",
+ "name": "type",
"required": false,
"type": "string"
},
@@ -3036,156 +3036,40 @@
"type": "uuid"
},
{
- "description": "the id of the host",
+ "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]",
"length": 255,
- "name": "id",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "name": "resourcestate",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
- "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]",
+ "description": "the id of the host",
"length": 255,
- "name": "outofbandmanagementpowerstate",
+ "name": "id",
+ "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "List by keyword",
+ "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
"length": 255,
- "name": "keyword",
+ "name": "hypervisor",
"required": false,
"type": "string"
}
],
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost",
"response": [
{
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
- "type": "long"
- },
- {
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
- "type": "string"
- },
- {
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
- "type": "string"
- },
- {
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "type": "date"
- },
- {
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "name": "hasenoughcapacity",
- "type": "boolean"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the cluster ID of the host",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
- },
- {
- "description": "the Zone ID of the host",
- "name": "zoneid",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {},
- {
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
- },
- {
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
- },
- {
- "description": "the admin that annotated this host",
- "name": "username",
- "type": "string"
- },
- {
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
- },
- {
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
- },
- {
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "the amount of the host's CPU currently allocated in MHz",
- "name": "cpuallocatedvalue",
- "type": "long"
- },
- {
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
- "type": "boolean"
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
},
{
"description": "Host details in key/value pairs.",
"name": "details",
"type": "map"
},
- {
- "description": "the cluster name of the host",
- "name": "clustername",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{
"description": "GPU cards present in the host",
"name": "gpugroup",
@@ -3200,18 +3084,18 @@
"name": "vgpu",
"response": [
{
- "description": "Model Name of vGPU",
- "name": "vgputype",
- "type": "string"
+ "description": "Video RAM for this vGPU type",
+ "name": "videoram",
+ "type": "long"
},
{
- "description": "Maximum displays per user",
- "name": "maxheads",
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
"type": "long"
},
{
- "description": "Maximum X resolution per display",
- "name": "maxresolutionx",
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
"type": "long"
},
{
@@ -3220,23 +3104,23 @@
"type": "long"
},
{
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "name": "maxcapacity",
+ "description": "Maximum no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
"type": "long"
},
{
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
+ "description": "Maximum displays per user",
+ "name": "maxheads",
"type": "long"
},
{
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "name": "maxvgpuperpgpu",
- "type": "long"
+ "description": "Model Name of vGPU",
+ "name": "vgputype",
+ "type": "string"
},
{
- "description": "Video RAM for this vGPU type",
- "name": "videoram",
+ "description": "Maximum X resolution per display",
+ "name": "maxresolutionx",
"type": "long"
}
],
@@ -3246,175 +3130,291 @@
"type": "list"
},
{
- "description": "the CPU number of the host",
- "name": "cpunumber",
- "type": "integer"
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
},
{
- "description": "the last annotation set on this host by an admin",
- "name": "annotation",
+ "description": "the Zone name of the host",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the resource state of the host",
- "name": "resourcestate",
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
"type": "string"
},
{
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
"type": "long"
},
{
- "description": "the management server ID of the host",
- "name": "managementserverid",
- "type": "string"
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
},
{
- "description": "the name of the host",
- "name": "name",
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
"type": "string"
},
{
- "description": "the Zone name of the host",
- "name": "zonename",
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
"type": "string"
},
+ {
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
{
"description": "comma-separated list of tags for the host",
"name": "hosttags",
"type": "string"
},
{
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
},
{
- "description": "the host type",
- "name": "type",
- "type": "type"
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
},
{
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
+ "description": "the cluster name of the host",
+ "name": "clustername",
"type": "string"
},
{
- "description": "the IP address of the host",
- "name": "ipaddress",
+ "description": "the ID of the host",
+ "name": "id",
"type": "string"
},
{
- "description": "true if the host supports encryption",
- "name": "encryptionsupported",
+ "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
+ "name": "suitableformigration",
"type": "boolean"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the amount of the host's memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
"type": "long"
},
{
- "description": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
- "type": "boolean"
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
},
{
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
- "type": "long"
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
},
{
- "description": "the host HA information information",
- "name": "hostha",
- "type": "hostharesponse"
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
},
{
"description": "the last time this host was annotated",
"name": "lastannotated",
"type": "date"
},
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
{
"description": "the host hypervisor",
"name": "hypervisor",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
},
{
- "description": "the state of the host",
- "name": "state",
- "type": "status"
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
},
{
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
+ {
+ "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
+ "name": "hasenoughcapacity",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the host supports encryption",
+ "name": "encryptionsupported",
+ "type": "boolean"
+ },
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "type": "string"
+ },
{
"description": "Whether the informed tag is a JS interpretable rule or not.",
"name": "istagarule",
"type": "boolean"
},
{
- "description": "the host version",
- "name": "version",
+ "description": "the last annotation set on this host by an admin",
+ "name": "annotation",
"type": "string"
},
{
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
},
{
- "description": "capabilities of the host",
- "name": "capabilities",
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
+ },
+ {
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {},
+ {
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
"type": "string"
},
{
- "description": "the ID of the host",
- "name": "id",
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
"type": "string"
},
{
- "description": "the OS category name of the host",
- "name": "oscategoryname",
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
"type": "string"
},
{
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
"type": "long"
},
{
- "description": "the Pod name of the host",
- "name": "podname",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
"type": "string"
},
{},
{
- "description": "events available for the host",
- "name": "events",
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
"type": "string"
},
{
- "description": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
},
{
"description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
@@ -3422,13 +3422,13 @@
"type": "string"
},
{
- "description": "the CPU speed of the host",
- "name": "cpuspeed",
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
"type": "long"
},
{
- "description": "the amount of the host's CPU currently allocated in percentage",
- "name": "cpuallocatedpercentage",
+ "description": "the Pod name of the host",
+ "name": "podname",
"type": "string"
}
]
@@ -3442,7 +3442,7 @@
"description": "Storage pool id",
"length": 255,
"name": "id",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools",
+ "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
"required": true,
"type": "uuid"
},
@@ -3455,7 +3455,16 @@
}
],
"response": [
- {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -3466,17 +3475,8 @@
"name": "displaytext",
"type": "string"
},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{},
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- }
+ {}
]
},
{
@@ -3484,13 +3484,6 @@
"isasync": false,
"name": "listVsphereStoragePolicyCompatiblePools",
"params": [
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
{
"description": "List by keyword",
"length": 255,
@@ -3499,12 +3492,11 @@
"type": "string"
},
{
- "description": "ID of the zone",
+ "description": "",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "page",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
"description": "ID of the storage policy",
@@ -3514,6 +3506,14 @@
"required": false,
"type": "uuid"
},
+ {
+ "description": "ID of the zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
{
"description": "",
"length": 255,
@@ -3525,23 +3525,38 @@
"related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
"response": [
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the Zone name of the storage pool",
- "name": "zonename",
+ "description": "the name of the storage pool",
+ "name": "name",
"type": "string"
},
{
- "description": "the Pod ID of the storage pool",
- "name": "podid",
+ "description": "the date and time the storage pool was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the storage pool path",
+ "name": "path",
"type": "string"
},
{
- "description": "the Pod name of the storage pool",
- "name": "podname",
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "Storage provider for this pool",
+ "name": "provider",
"type": "string"
},
{
@@ -3550,14 +3565,14 @@
"type": "string"
},
{
- "description": "the total disk size of the storage pool",
- "name": "disksizetotal",
- "type": "long"
+ "description": "Whether the informed tag is a JS interpretable rule or not.",
+ "name": "istagarule",
+ "type": "boolean"
},
{
- "description": "the storage pool capabilities",
- "name": "storagecapabilities",
- "type": "map"
+ "description": "the tags for the storage pool",
+ "name": "tags",
+ "type": "string"
},
{
"description": "the host's currently allocated disk size",
@@ -3565,49 +3580,29 @@
"type": "long"
},
{
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
- },
- {},
- {
- "description": "the storage pool path",
- "name": "path",
+ "description": "the scope of the storage pool",
+ "name": "scope",
"type": "string"
},
{
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the date and time the storage pool was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "true if this pool is suitable to migrate a volume, false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "Whether the informed tag is a JS interpretable rule or not.",
- "name": "istagarule",
- "type": "boolean"
- },
- {
- "description": "the state of the storage pool",
- "name": "state",
- "type": "storagepoolstatus"
+ "description": "IOPS CloudStack can provision from this storage pool",
+ "name": "capacityiops",
+ "type": "long"
},
{
- "description": "Storage provider for this pool",
- "name": "provider",
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
"type": "string"
},
+ {},
{
- "description": "the ID of the storage pool",
- "name": "id",
+ "description": "the Pod ID of the storage pool",
+ "name": "podid",
"type": "string"
},
{
@@ -3616,8 +3611,8 @@
"type": "boolean"
},
{
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
+ "description": "the ID of the storage pool",
+ "name": "id",
"type": "string"
},
{
@@ -3626,50 +3621,55 @@
"type": "string"
},
{
- "description": "total min IOPS currently in use by volumes",
- "name": "allocatediops",
- "type": "long"
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
+ "type": "string"
},
{
- "description": "the tags for the storage pool",
- "name": "tags",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the IP address of the storage pool",
- "name": "ipaddress",
+ "description": "the storage pool type",
+ "name": "type",
"type": "string"
},
{
- "description": "the scope of the storage pool",
- "name": "scope",
- "type": "string"
+ "description": "the storage pool capabilities",
+ "name": "storagecapabilities",
+ "type": "map"
},
{},
{
- "description": "the storage pool type",
- "name": "type",
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "the name of the storage pool",
- "name": "name",
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "IOPS CloudStack can provision from this storage pool",
- "name": "capacityiops",
+ "description": "total min IOPS currently in use by volumes",
+ "name": "allocatediops",
"type": "long"
},
{
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
"type": "string"
+ },
+ {
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "storagepoolstatus"
+ },
+ {
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
+ "type": "long"
}
]
},
@@ -3689,26 +3689,26 @@
],
"response": [
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
},
{},
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
{},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
}
],
"since": "4.17.0.0"
@@ -3718,6 +3718,13 @@
"isasync": false,
"name": "updateStoragePool",
"params": [
+ {
+ "description": "comma-separated list of tags for the storage pool",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "list"
+ },
{
"description": "the URL of the storage pool",
"length": 255,
@@ -3734,12 +3741,11 @@
"type": "boolean"
},
{
- "description": "the Id of the storage pool",
+ "description": "bytes CloudStack can provision from this storage pool",
"length": 255,
- "name": "id",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
- "required": true,
- "type": "uuid"
+ "name": "capacitybytes",
+ "required": false,
+ "type": "long"
},
{
"description": "false to disable the pool for allocation of new volumes, true to enable it back.",
@@ -3748,6 +3754,14 @@
"required": false,
"type": "boolean"
},
+ {
+ "description": "the Id of the storage pool",
+ "length": 255,
+ "name": "id",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
+ "required": true,
+ "type": "uuid"
+ },
{
"description": "the details for the storage pool",
"length": 255,
@@ -3765,20 +3779,6 @@
"since": "4.15",
"type": "string"
},
- {
- "description": "comma-separated list of tags for the storage pool",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "list"
- },
- {
- "description": "bytes CloudStack can provision from this storage pool",
- "length": 255,
- "name": "capacitybytes",
- "required": false,
- "type": "long"
- },
{
"description": "IOPS CloudStack can provision from this storage pool",
"length": 255,
@@ -3789,75 +3789,62 @@
],
"related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
"response": [
+ {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
+ "type": "string"
},
{
- "description": "total min IOPS currently in use by volumes",
- "name": "allocatediops",
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
"type": "long"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "Whether the informed tag is a JS interpretable rule or not.",
- "name": "istagarule",
- "type": "boolean"
- },
- {
- "description": "true if this pool is suitable to migrate a volume, false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
- },
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
+ "description": "the storage pool path",
+ "name": "path",
+ "type": "string"
},
{
- "description": "the IP address of the storage pool",
- "name": "ipaddress",
+ "description": "the tags for the storage pool",
+ "name": "tags",
"type": "string"
},
{
- "description": "the Pod name of the storage pool",
- "name": "podname",
+ "description": "the name of the storage pool",
+ "name": "name",
"type": "string"
},
{
- "description": "the ID of the storage pool",
- "name": "id",
- "type": "string"
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
+ "type": "long"
},
{
- "description": "the storage pool path",
- "name": "path",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
+ {},
{
- "description": "the scope of the storage pool",
- "name": "scope",
- "type": "string"
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
},
{
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
+ "description": "total min IOPS currently in use by volumes",
+ "name": "allocatediops",
+ "type": "long"
},
{
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
+ "description": "the ID of the storage pool",
+ "name": "id",
"type": "string"
},
{
- "description": "the total disk size of the storage pool",
- "name": "disksizetotal",
- "type": "long"
+ "description": "the date and time the storage pool was created",
+ "name": "created",
+ "type": "date"
},
{
"description": "the storage pool capabilities",
@@ -3865,29 +3852,24 @@
"type": "map"
},
{
- "description": "the date and time the storage pool was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "Storage provider for this pool",
- "name": "provider",
+ "description": "the Pod ID of the storage pool",
+ "name": "podid",
"type": "string"
},
{
- "description": "the Zone name of the storage pool",
- "name": "zonename",
+ "description": "the storage pool type",
+ "name": "type",
"type": "string"
},
{
- "description": "the ID of the cluster for the storage pool",
- "name": "clusterid",
+ "description": "the scope of the storage pool",
+ "name": "scope",
"type": "string"
},
{
- "description": "the name of the cluster for the storage pool",
- "name": "clustername",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "IOPS CloudStack can provision from this storage pool",
@@ -3895,35 +3877,28 @@
"type": "long"
},
{
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
- "type": "string"
+ "description": "Whether the informed tag is a JS interpretable rule or not.",
+ "name": "istagarule",
+ "type": "boolean"
},
{
- "description": "the storage pool type",
- "name": "type",
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
- },
- {},
- {
- "description": "the tags for the storage pool",
- "name": "tags",
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
"type": "string"
},
- {},
{
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
- "type": "string"
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
},
{
- "description": "the Pod ID of the storage pool",
- "name": "podid",
+ "description": "the ID of the cluster for the storage pool",
+ "name": "clusterid",
"type": "string"
},
{
@@ -3932,10 +3907,35 @@
"type": "storagepoolstatus"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "Storage provider for this pool",
+ "name": "provider",
"type": "string"
- }
+ },
+ {
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
+ "type": "string"
+ },
+ {
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
+ "type": "string"
+ }
],
"since": "3.0.0"
},
@@ -3964,39 +3964,34 @@
"related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm",
"response": [
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the link local IP address for the system vm",
- "name": "linklocalip",
+ "description": "the link local MAC address for the system vm",
+ "name": "linklocalmacaddress",
"type": "string"
},
{
- "description": "the link local MAC address for the system vm",
- "name": "linklocalmacaddress",
+ "description": "the ID of the service offering of the system virtual machine.",
+ "name": "serviceofferingid",
"type": "string"
},
{},
{
- "description": "guest vlan range",
- "name": "guestvlan",
- "type": "string"
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
},
{
- "description": "the link local netmask for the system vm",
- "name": "linklocalnetmask",
+ "description": "the network domain for the system VM",
+ "name": "networkdomain",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the gateway for the system VM",
+ "name": "gateway",
"type": "string"
},
{
- "description": "the template ID for the system VM",
- "name": "templateid",
+ "description": "the systemvm agent version",
+ "name": "version",
"type": "string"
},
{
@@ -4005,59 +4000,59 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the name of the system VM",
+ "name": "name",
+ "type": "string"
},
{
- "description": "the Zone ID for the system VM",
- "name": "zoneid",
+ "description": "the host ID for the system VM",
+ "name": "hostid",
"type": "string"
},
{
- "description": "the hostname for the system VM",
- "name": "hostname",
+ "description": "the Zone name for the system VM",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the systemvm agent version",
- "name": "version",
+ "description": "the public netmask for the system VM",
+ "name": "publicnetmask",
"type": "string"
},
{
- "description": "the private IP address for the system VM",
- "name": "privateip",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the template name for the system VM",
- "name": "templatename",
- "type": "string"
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
},
{
- "description": "the Pod name for the system VM",
- "name": "podname",
+ "description": "the agent state of the system VM",
+ "name": "agentstate",
"type": "string"
},
{
- "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.",
- "name": "jobstatus",
- "type": "integer"
+ "description": "guest vlan range",
+ "name": "guestvlan",
+ "type": "string"
},
{
- "description": "the private netmask for the system VM",
- "name": "privatenetmask",
+ "description": "the Pod ID for the system VM",
+ "name": "podid",
"type": "string"
},
{
- "description": "the ID of the system VM",
- "name": "id",
+ "description": "the private IP address for the system VM",
+ "name": "privateip",
"type": "string"
},
{
- "description": "the last disconnected date of host",
- "name": "disconnected",
- "type": "date"
+ "description": "the private MAC address for the system VM",
+ "name": "privatemacaddress",
+ "type": "string"
},
{
"description": "the public MAC address for the system VM",
@@ -4065,34 +4060,29 @@
"type": "string"
},
{
- "description": "the system VM type",
- "name": "systemvmtype",
- "type": "string"
- },
- {
- "description": "the private MAC address for the system VM",
- "name": "privatemacaddress",
+ "description": "the state of the system VM",
+ "name": "state",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
+ "description": "public vlan range",
+ "name": "publicvlan",
+ "type": "list"
},
{
- "description": "the network domain for the system VM",
- "name": "networkdomain",
+ "description": "the template name for the system VM",
+ "name": "templatename",
"type": "string"
},
{
- "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.",
- "name": "jobid",
+ "description": "the private netmask for the system VM",
+ "name": "privatenetmask",
"type": "string"
},
{
- "description": "the public IP address for the system VM",
- "name": "publicip",
- "type": "string"
+ "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "the number of active console sessions for the console proxy system vm",
@@ -4100,9 +4090,14 @@
"type": "integer"
},
{
- "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
- "name": "isdynamicallyscalable",
- "type": "boolean"
+ "description": "the link local IP address for the system vm",
+ "name": "linklocalip",
+ "type": "string"
+ },
+ {
+ "description": "the template ID for the system VM",
+ "name": "templateid",
+ "type": "string"
},
{
"description": "the second DNS for the system VM",
@@ -4110,19 +4105,25 @@
"type": "string"
},
{
- "description": "the state of the system VM",
- "name": "state",
+ "description": "the public IP address for the system VM",
+ "name": "publicip",
"type": "string"
},
{
- "description": "public vlan range",
- "name": "publicvlan",
- "type": "list"
+ "description": "the link local netmask for the system vm",
+ "name": "linklocalnetmask",
+ "type": "string"
},
{
- "description": "the public netmask for the system VM",
- "name": "publicnetmask",
- "type": "string"
+ "description": "the date and time the system VM was created",
+ "name": "created",
+ "type": "date"
+ },
+ {},
+ {
+ "description": "the last disconnected date of host",
+ "name": "disconnected",
+ "type": "date"
},
{
"description": "the first DNS for the system VM",
@@ -4130,51 +4131,50 @@
"type": "string"
},
{
- "description": "the Pod ID for the system VM",
- "name": "podid",
+ "description": "the ID of the system VM",
+ "name": "id",
"type": "string"
},
{
- "description": "the agent state of the system VM",
- "name": "agentstate",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the host ID for the system VM",
- "name": "hostid",
+ "description": "the Zone ID for the system VM",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the name of the system VM",
- "name": "name",
+ "description": "the control state of the host for the system VM",
+ "name": "hostcontrolstate",
"type": "string"
},
{
- "description": "the ID of the service offering of the system virtual machine.",
- "name": "serviceofferingid",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the date and time the system VM was created",
- "name": "created",
- "type": "date"
+ "description": "the Pod name for the system VM",
+ "name": "podname",
+ "type": "string"
},
{
- "description": "the control state of the host for the system VM",
- "name": "hostcontrolstate",
+ "description": "the system VM type",
+ "name": "systemvmtype",
"type": "string"
},
{
- "description": "the Zone name for the system VM",
- "name": "zonename",
+ "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the gateway for the system VM",
- "name": "gateway",
+ "description": "the hostname for the system VM",
+ "name": "hostname",
"type": "string"
- },
- {}
+ }
]
},
{
@@ -4183,23 +4183,16 @@
"name": "listTungstenFabricTag",
"params": [
{
- "description": "the uuid of Tungsten-Fabric network",
- "length": 255,
- "name": "networkuuid",
- "required": false,
- "type": "string"
- },
- {
- "description": "the uuid of Tungsten-Fabric application policy set",
+ "description": "",
"length": 255,
- "name": "applicationpolicysetuuid",
+ "name": "pagesize",
"required": false,
- "type": "string"
+ "type": "integer"
},
{
- "description": "List by keyword",
+ "description": "the uuid of Tungsten-Fabric network",
"length": 255,
- "name": "keyword",
+ "name": "networkuuid",
"required": false,
"type": "string"
},
@@ -4211,23 +4204,31 @@
"type": "string"
},
{
- "description": "the uuid of Tungsten-Fabric tag",
+ "description": "the ID of zone",
"length": 255,
- "name": "taguuid",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
{
- "description": "the uuid of Tungsten-Fabric policy",
+ "description": "the uuid of Tungsten-Fabric application policy set",
"length": 255,
- "name": "policyuuid",
+ "name": "applicationpolicysetuuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
"required": false,
"type": "string"
},
@@ -4239,47 +4240,47 @@
"type": "string"
},
{
- "description": "",
+ "description": "the uuid of Tungsten-Fabric policy",
"length": 255,
- "name": "page",
+ "name": "policyuuid",
"required": false,
- "type": "integer"
+ "type": "string"
},
{
- "description": "the ID of zone",
+ "description": "the uuid of Tungsten-Fabric tag",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "taguuid",
"required": false,
- "type": "uuid"
+ "type": "string"
}
],
"related": "createTungstenFabricTag,applyTungstenFabricTag,removeTungstenFabricTag",
"response": [
{
- "description": "Tungsten-Fabric provider zone name",
- "name": "zonename",
- "type": "string"
+ "description": "list Tungsten-Fabric policy",
+ "name": "policy",
+ "type": "list"
},
{
- "description": "Tungsten-Fabric tag type uuid",
- "name": "uuid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "list Tungsten-Fabric vm",
- "name": "vm",
+ "description": "list Tungsten-Fabric network",
+ "name": "network",
"type": "list"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "list Tungsten-Fabric nic",
+ "name": "nic",
+ "type": "list"
},
+ {},
{
- "description": "list Tungsten-Fabric policy",
- "name": "policy",
- "type": "list"
+ "description": "Tungsten-Fabric tag type uuid",
+ "name": "uuid",
+ "type": "string"
},
{
"description": "Tungsten-Fabric provider zone id",
@@ -4287,27 +4288,26 @@
"type": "long"
},
{
- "description": "list Tungsten-Fabric network",
- "name": "network",
- "type": "list"
- },
- {},
- {
- "description": "list Tungsten-Fabric nic",
- "name": "nic",
- "type": "list"
+ "description": "Tungsten-Fabric provider zone name",
+ "name": "zonename",
+ "type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
+ {},
{
"description": "Tungsten-Fabric tag name",
"name": "name",
"type": "string"
},
- {}
+ {
+ "description": "list Tungsten-Fabric vm",
+ "name": "vm",
+ "type": "list"
+ }
]
},
{
@@ -4315,20 +4315,6 @@
"isasync": false,
"name": "importLdapUsers",
"params": [
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
{
"description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
"length": 255,
@@ -4337,11 +4323,12 @@
"type": "string"
},
{
- "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
+ "description": "Creates the account under the specified role.",
"length": 255,
- "name": "accounttype",
+ "name": "roleid",
+ "related": "createRole,importRole,listRoles,updateRole",
"required": false,
- "type": "integer"
+ "type": "uuid"
},
{
"description": "details for account used to store specific parameters",
@@ -4353,18 +4340,10 @@
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
- {
- "description": "Creates the account under the specified role.",
- "length": 255,
- "name": "roleid",
- "related": "createRole,importRole,listRoles,updateRole",
- "required": false,
- "type": "uuid"
- },
{
"description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.",
"length": 255,
@@ -4380,24 +4359,45 @@
"required": false,
"type": "uuid"
},
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
{
"description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
"length": 255,
"name": "timezone",
"required": false,
"type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
+ "length": 255,
+ "name": "accounttype",
+ "required": false,
+ "type": "integer"
}
],
"related": "searchLdap,listLdapUsers",
"response": [
{
- "description": "The user's firstname",
- "name": "firstname",
+ "description": "The user's email",
+ "name": "email",
"type": "string"
},
{
- "description": "The user's email",
- "name": "email",
+ "description": "The user's domain",
+ "name": "domain",
"type": "string"
},
{
@@ -4406,34 +4406,34 @@
"type": "string"
},
{
- "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.",
- "name": "conflictingusersource",
+ "description": "The user's firstname",
+ "name": "firstname",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "The user's lastname",
+ "name": "lastname",
+ "type": "string"
},
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "The user's principle",
+ "name": "principal",
"type": "string"
},
{
- "description": "The user's lastname",
- "name": "lastname",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "The user's domain",
- "name": "domain",
+ "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.",
+ "name": "conflictingusersource",
"type": "string"
},
+ {},
{
- "description": "The user's principle",
- "name": "principal",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{}
@@ -4464,40 +4464,19 @@
],
"related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"response": [
- {
- "description": "the domain name of the parent domain",
- "name": "parentdomainname",
- "type": "string"
- },
- {
- "description": "the total secondary storage space (in GiB) the domain can own",
- "name": "secondarystoragelimit",
- "type": "string"
- },
- {
- "description": "the total volume which can be used by this domain",
- "name": "volumelimit",
- "type": "string"
- },
- {},
{
"description": "the total primary storage space (in GiB) available to be used for this domain",
"name": "primarystorageavailable",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the total secondary storage space (in GiB) available to be used for this domain",
- "name": "secondarystorageavailable",
+ "description": "the domain name of the parent domain",
+ "name": "parentdomainname",
"type": "string"
},
{
- "description": "the total volume available for this domain",
- "name": "volumeavailable",
+ "description": "the total number of cpu cores the domain can own",
+ "name": "cpulimit",
"type": "string"
},
{
@@ -4506,38 +4485,23 @@
"type": "string"
},
{
- "description": "the total number of vpcs available to be created for this domain",
- "name": "vpcavailable",
- "type": "string"
- },
- {
- "description": "the total number of networks owned by domain",
- "name": "networktotal",
+ "description": "the total number of templates which have been created by this domain",
+ "name": "templatetotal",
"type": "long"
},
{
- "description": "the total number of virtual machines that can be deployed by this domain",
- "name": "vmlimit",
- "type": "string"
- },
- {
- "description": "the total number of templates available to be created by this domain",
- "name": "templateavailable",
+ "description": "the total number of templates which can be created by this domain",
+ "name": "templatelimit",
"type": "string"
},
{
- "description": "the ID of the domain",
- "name": "id",
+ "description": "the total number of networks the domain can own",
+ "name": "networklimit",
"type": "string"
},
{
- "description": "the total number of snapshots stored by this domain",
- "name": "snapshottotal",
- "type": "long"
- },
- {
- "description": "the total number of projects the domain can own",
- "name": "projectlimit",
+ "description": "the total number of vpcs the domain can own",
+ "name": "vpclimit",
"type": "string"
},
{
@@ -4546,118 +4510,83 @@
"type": "string"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
- },
- {
- "description": "the total number of projects available for administration by this domain",
- "name": "projectavailable",
+ "description": "the total memory (in MB) available to be created for this domain",
+ "name": "memoryavailable",
"type": "string"
},
{
- "description": "the state of the domain",
- "name": "state",
+ "description": "the path of the domain",
+ "name": "path",
"type": "string"
},
{
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
- "type": "boolean"
- },
- {
- "description": "the total secondary storage space (in GiB) owned by domain",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
- "description": "the total number of virtual machines available for this domain to acquire",
- "name": "vmavailable",
+ "description": "the ID of the domain",
+ "name": "id",
"type": "string"
},
- {
- "description": "the total primary storage space (in GiB) owned by domain",
- "name": "primarystoragetotal",
- "type": "long"
- },
{
"description": "the level of the domain",
"name": "level",
"type": "integer"
},
{
- "description": "the total number of networks available to be created for this domain",
- "name": "networkavailable",
- "type": "string"
- },
- {
- "description": "the total volume being used by this domain",
- "name": "volumetotal",
- "type": "long"
- },
- {
- "description": "the path of the domain",
- "name": "path",
+ "description": "the total number of virtual machines available for this domain to acquire",
+ "name": "vmavailable",
"type": "string"
},
{
- "description": "the total number of templates which can be created by this domain",
- "name": "templatelimit",
+ "description": "the total secondary storage space (in GiB) the domain can own",
+ "name": "secondarystoragelimit",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the total number of vpcs available to be created for this domain",
+ "name": "vpcavailable",
"type": "string"
},
{
- "description": "the total number of cpu cores owned by domain",
- "name": "cputotal",
- "type": "long"
+ "description": "whether the domain has one or more sub-domains",
+ "name": "haschild",
+ "type": "boolean"
},
{
- "description": "the total number of vpcs the domain can own",
- "name": "vpclimit",
- "type": "string"
+ "description": "details for the domain",
+ "name": "domaindetails",
+ "type": "map"
},
{
- "description": "the total memory (in MB) available to be created for this domain",
- "name": "memoryavailable",
+ "description": "the total number of public ip addresses this domain can acquire",
+ "name": "iplimit",
"type": "string"
},
{
- "description": "the network domain",
- "name": "networkdomain",
+ "description": "the total number of snapshots available for this domain",
+ "name": "snapshotavailable",
"type": "string"
},
{
- "description": "the date when this domain was created",
- "name": "created",
- "type": "date"
+ "description": "the total number of projects being administrated by this domain",
+ "name": "projecttotal",
+ "type": "long"
},
{
- "description": "the total number of public ip addresses this domain can acquire",
- "name": "iplimit",
+ "description": "the network domain",
+ "name": "networkdomain",
"type": "string"
},
{
- "description": "the total number of templates which have been created by this domain",
- "name": "templatetotal",
- "type": "long"
- },
- {
- "description": "the total number of snapshots available for this domain",
- "name": "snapshotavailable",
+ "description": "the total number of templates available to be created by this domain",
+ "name": "templateavailable",
"type": "string"
},
{
- "description": "the total number of public ip addresses available for this domain to acquire",
- "name": "ipavailable",
+ "description": "the total memory (in MB) the domain can own",
+ "name": "memorylimit",
"type": "string"
},
{
- "description": "the total number of networks the domain can own",
- "name": "networklimit",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -4666,34 +4595,35 @@
"type": "string"
},
{
- "description": "the total primary storage space (in GiB) the domain can own",
- "name": "primarystoragelimit",
- "type": "string"
+ "description": "the total primary storage space (in GiB) owned by domain",
+ "name": "primarystoragetotal",
+ "type": "long"
},
+ {},
{
- "description": "whether the domain has one or more sub-domains",
- "name": "haschild",
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
"type": "boolean"
},
- {
- "description": "the total number of vpcs owned by domain",
- "name": "vpctotal",
- "type": "long"
- },
{
"description": "the name of the domain",
"name": "name",
"type": "string"
},
{
- "description": "the total memory (in MB) the domain can own",
- "name": "memorylimit",
+ "description": "the total volume which can be used by this domain",
+ "name": "volumelimit",
"type": "string"
},
{
- "description": "the total number of virtual machines deployed by this domain",
- "name": "vmtotal",
- "type": "long"
+ "description": "the total volume available for this domain",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects available for administration by this domain",
+ "name": "projectavailable",
+ "type": "string"
},
{
"description": "the total memory (in MB) owned by domain",
@@ -4701,98 +4631,64 @@
"type": "long"
},
{
- "description": "the total number of public ip addresses allocated for this domain",
- "name": "iptotal",
+ "description": "the total number of networks owned by domain",
+ "name": "networktotal",
"type": "long"
},
{
- "description": "details for the domain",
- "name": "domaindetails",
- "type": "map"
+ "description": "the total number of projects the domain can own",
+ "name": "projectlimit",
+ "type": "string"
},
{
- "description": "the total number of projects being administrated by this domain",
- "name": "projecttotal",
- "type": "long"
+ "description": "the total number of networks available to be created for this domain",
+ "name": "networkavailable",
+ "type": "string"
},
{
- "description": "the total number of cpu cores the domain can own",
- "name": "cpulimit",
+ "description": "the state of the domain",
+ "name": "state",
"type": "string"
},
- {}
- ],
- "since": "4.19.0.0"
- },
- {
- "description": "List dedicated zones.",
- "isasync": false,
- "name": "listDedicatedZones",
- "params": [
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
+ "description": "the total number of public ip addresses allocated for this domain",
+ "name": "iptotal",
+ "type": "long"
},
{
- "description": "the ID of the Zone",
- "length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
- "required": false,
- "type": "uuid"
+ "description": "the total number of virtual machines deployed by this domain",
+ "name": "vmtotal",
+ "type": "long"
},
{
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
+ "description": "the total number of snapshots stored by this domain",
+ "name": "snapshottotal",
+ "type": "long"
},
{
- "description": "list dedicated zones by affinity group",
- "length": 255,
- "name": "affinitygroupid",
- "related": "createAffinityGroup,listAffinityGroups",
- "required": false,
- "type": "uuid"
+ "description": "the date when this domain was created",
+ "name": "created",
+ "type": "date"
},
{
- "description": "the name of the account associated with the zone. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
+ "description": "the total number of virtual machines that can be deployed by this domain",
+ "name": "vmlimit",
"type": "string"
},
{
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
+ "description": "the total number of vpcs owned by domain",
+ "name": "vpctotal",
+ "type": "long"
},
{
- "description": "the ID of the domain associated with the zone",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
- }
- ],
- "related": "dedicateZone",
- "response": [
- {},
- {
- "description": "the Account Id to which the Zone is dedicated",
- "name": "accountid",
- "type": "string"
+ "description": "the total volume being used by this domain",
+ "name": "volumetotal",
+ "type": "long"
},
+ {},
{
- "description": "the ID of the dedicated resource",
- "name": "id",
+ "description": "the total primary storage space (in GiB) the domain can own",
+ "name": "primarystoragelimit",
"type": "string"
},
{
@@ -4801,32 +4697,32 @@
"type": "integer"
},
{
- "description": "the domain ID to which the Zone is dedicated",
- "name": "domainid",
- "type": "string"
+ "description": "the total secondary storage space (in GiB) owned by domain",
+ "name": "secondarystoragetotal",
+ "type": "float"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the total secondary storage space (in GiB) available to be used for this domain",
+ "name": "secondarystorageavailable",
"type": "string"
},
- {},
{
- "description": "the Name of the Zone",
- "name": "zonename",
- "type": "string"
+ "description": "the total number of cpu cores owned by domain",
+ "name": "cputotal",
+ "type": "long"
},
{
- "description": "the ID of the Zone",
- "name": "zoneid",
- "type": "string"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
},
{
- "description": "the Dedication Affinity Group ID of the zone",
- "name": "affinitygroupid",
+ "description": "the total number of public ip addresses available for this domain to acquire",
+ "name": "ipavailable",
"type": "string"
}
- ]
+ ],
+ "since": "4.19.0.0"
},
{
"description": "Lists all available networks.",
@@ -4834,84 +4730,93 @@
"name": "listNetworks",
"params": [
{
- "description": "list networks by ID",
+ "description": "type of the traffic",
"length": 255,
- "name": "id",
- "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "name": "traffictype",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "description": "list networks by restartRequired",
"length": 255,
- "name": "displaynetwork",
+ "name": "restartrequired",
"required": false,
- "since": "4.4",
"type": "boolean"
},
{
- "description": "list networks by network offering ID",
+ "description": "the zone ID of the network",
"length": 255,
- "name": "networkofferingid",
- "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
"type": "uuid"
},
{
- "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "listall",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
- "type": "boolean"
+ "type": "uuid"
},
{
- "description": "true if network is system, false otherwise",
+ "description": "the type of the network. Supported values are: isolated, l2, shared and all",
"length": 255,
- "name": "issystem",
+ "name": "type",
"required": false,
- "type": "boolean"
+ "type": "string"
},
{
- "description": "",
+ "description": "list networks by ID",
"length": 255,
- "name": "pagesize",
+ "name": "id",
+ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
- "type": "integer"
+ "type": "uuid"
},
{
- "description": "the type of the network. Supported values are: isolated, l2, shared and all",
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.",
"length": 255,
- "name": "type",
+ "name": "listall",
"required": false,
- "type": "string"
+ "type": "boolean"
},
{
- "description": "list objects by project; if projectid=-1 lists All VMs",
+ "description": "flag to display the resource icon for networks",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "name": "showicon",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "List networks by associated networks. Only available if create a Shared network.",
+ "length": 255,
+ "name": "associatednetworkid",
+ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
+ "since": "4.17.0",
"type": "uuid"
},
{
- "description": "list resources by account. Must be used with the domainId parameter.",
+ "description": "makes the API's response contains only the resource count",
"length": 255,
- "name": "account",
+ "name": "retrieveonlyresourcecount",
"required": false,
- "type": "string"
+ "type": "boolean"
},
{
- "description": "list networks by restartRequired",
+ "description": "true if need to list only networks which support specifying IP ranges",
"length": 255,
- "name": "restartrequired",
+ "name": "specifyipranges",
"required": false,
"type": "boolean"
},
{
- "description": "list networks available for VM deployment",
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
"length": 255,
- "name": "canusefordeploy",
+ "name": "displaynetwork",
"required": false,
+ "since": "4.4",
"type": "boolean"
},
{
@@ -4922,117 +4827,115 @@
"type": "string"
},
{
- "description": "List networks by VPC",
+ "description": "the ID or VID of the network",
"length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
+ "name": "vlan",
"required": false,
- "type": "uuid"
+ "since": "4.17.0",
+ "type": "string"
},
{
- "description": "",
+ "description": "the network belongs to VPC",
"length": 255,
- "name": "page",
+ "name": "forvpc",
"required": false,
- "type": "integer"
+ "type": "boolean"
},
{
- "description": "the zone ID of the network",
+ "description": "list networks supporting certain services",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "supportedservices",
"required": false,
- "type": "uuid"
+ "type": "list"
},
{
- "description": "list networks by physical network id",
+ "description": "list networks available for VM deployment",
"length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork",
+ "name": "canusefordeploy",
"required": false,
- "type": "uuid"
+ "type": "boolean"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "pagesize",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
- "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by [...]
+ "description": "",
"length": 255,
- "name": "networkfilter",
+ "name": "page",
"required": false,
- "since": "4.17.0",
- "type": "string"
+ "type": "integer"
},
{
- "description": "list networks by ACL (access control list) type. Supported values are account and domain",
+ "description": "list networks by network offering ID",
"length": 255,
- "name": "acltype",
+ "name": "networkofferingid",
+ "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "flag to display the resource icon for networks",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "showicon",
+ "name": "account",
"required": false,
- "type": "boolean"
+ "type": "string"
},
{
- "description": "type of the traffic",
+ "description": "List networks by VPC",
"length": 255,
- "name": "traffictype",
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "makes the API's response contains only the resource count",
+ "description": "list networks by physical network id",
"length": 255,
- "name": "retrieveonlyresourcecount",
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork",
"required": false,
- "type": "boolean"
+ "type": "uuid"
},
{
- "description": "the network belongs to VPC",
+ "description": "true if network is system, false otherwise",
"length": 255,
- "name": "forvpc",
+ "name": "issystem",
"required": false,
"type": "boolean"
},
{
- "description": "the ID or VID of the network",
+ "description": "list networks by ACL (access control list) type. Supported values are account and domain",
"length": 255,
- "name": "vlan",
+ "name": "acltype",
"required": false,
- "since": "4.17.0",
"type": "string"
},
{
- "description": "true if need to list only networks which support specifying IP ranges",
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
- "name": "specifyipranges",
+ "name": "isrecursive",
"required": false,
"type": "boolean"
},
{
- "description": "List networks by associated networks. Only available if create a Shared network.",
+ "description": "list objects by project; if projectid=-1 lists All VMs",
"length": 255,
- "name": "associatednetworkid",
- "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
- "since": "4.17.0",
"type": "uuid"
},
{
- "description": "list networks supporting certain services",
+ "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by [...]
"length": 255,
- "name": "supportedservices",
+ "name": "networkfilter",
"required": false,
- "type": "list"
+ "since": "4.17.0",
+ "type": "string"
},
{
"description": "List resources by tags (key/value pairs)",
@@ -5040,100 +4943,64 @@
"name": "tags",
"required": false,
"type": "map"
- },
- {
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
- "length": 255,
- "name": "isrecursive",
- "required": false,
- "type": "boolean"
}
],
"related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
"response": [
{
- "description": "the name of the network",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the ID of the Network associated with this network",
- "name": "associatednetworkid",
- "type": "string"
- },
- {
- "description": "the physical network id",
- "name": "physicalnetworkid",
+ "description": "acl type - access type to the network",
+ "name": "acltype",
"type": "string"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
+ "description": "true if network supports specifying ip ranges, false otherwise",
+ "name": "specifyipranges",
+ "type": "boolean"
},
{
- "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
- "name": "networkcidr",
+ "description": "the name of the Network associated with this network",
+ "name": "associatednetwork",
"type": "string"
},
{
- "description": "the first IPv4 DNS for the network",
- "name": "dns1",
- "type": "string"
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
},
{
- "description": "Tungsten-Fabric virtual router the network belongs to",
- "name": "tungstenvirtualrouteruuid",
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the type of the network",
- "name": "type",
+ "description": "The vlan of the network. This parameter is visible to ROOT admins only",
+ "name": "vlan",
"type": "string"
},
{
- "description": "true if users from subdomains can access the domain level network",
- "name": "subdomainaccess",
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "networkofferingconservemode",
"type": "boolean"
},
{
- "description": "the displaytext of the network",
- "name": "displaytext",
- "type": "string"
- },
- {
- "description": "true if the entity/resource has annotations",
- "name": "hasannotations",
+ "description": "true network requires restart",
+ "name": "restartrequired",
"type": "boolean"
},
+ {},
{
- "description": "the network's gateway",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "MTU configured on the network VR's private interfaces",
- "name": "privatemtu",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
"type": "integer"
},
{
- "description": "the first IPv6 DNS for the network",
- "name": "ip6dns1",
- "type": "string"
- },
- {
- "description": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
- },
- {
- "description": "the traffic type of the network",
- "name": "traffictype",
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
"type": "string"
},
{
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
"type": "string"
},
{
@@ -5141,243 +5008,267 @@
"name": "tags",
"response": [
{
- "description": "tag key name",
- "name": "key",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
}
],
"type": "list"
},
{
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the second IPv4 DNS for the network",
- "name": "dns2",
+ "description": "the network's gateway",
+ "name": "gateway",
"type": "string"
},
{
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
"type": "string"
},
{
- "description": "the second IPv6 DNS for the network",
- "name": "ip6dns2",
- "type": "string"
+ "description": "The routes for the network to ease adding route in upstream router",
+ "name": "ip6routes",
+ "type": "set"
},
{
- "description": "path of the Domain the network belongs to",
- "name": "domainpath",
+ "description": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
"type": "string"
},
{
- "description": "true if network offering is ip conserve mode enabled",
- "name": "networkofferingconservemode",
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
"type": "boolean"
},
{
- "description": "Base64 string representation of the resource icon",
- "name": "icon",
- "type": "resourceiconresponse"
+ "description": "list networks that are persistent",
+ "name": "ispersistent",
+ "type": "boolean"
},
{
- "description": "the network's netmask",
- "name": "netmask",
+ "description": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
+ "type": "boolean"
+ },
+ {
+ "description": "Tungsten-Fabric virtual router the network belongs to",
+ "name": "tungstenvirtualrouteruuid",
"type": "string"
},
{
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "name": "cidr",
+ "description": "zone id of the network",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the domain name of the network owner",
- "name": "domain",
+ "description": "the owner of the network",
+ "name": "account",
"type": "string"
},
{
- "description": "VPC the network belongs to",
- "name": "vpcid",
+ "description": "true if network is system, false otherwise",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "the type of the network",
+ "name": "type",
"type": "string"
},
{
- "description": "the project name of the address",
- "name": "project",
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
"type": "string"
},
{
- "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
- "name": "broadcasturi",
+ "description": "the domain name of the network owner",
+ "name": "domain",
"type": "string"
},
{
- "description": "The routing mode of network offering",
- "name": "ip6routing",
+ "description": "the project name of the address",
+ "name": "project",
"type": "string"
},
{
- "description": "the name of the Network associated with this network",
+ "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
+ "name": "zonesnetworkspans",
+ "type": "set"
+ },
+ {
+ "description": "the name of the Network associated with this private gateway",
"name": "associatednetwork",
"type": "string"
},
{
- "description": "if network offering supports vm autoscaling feature",
- "name": "supportsvmautoscaling",
+ "description": "MTU configured on the network VR's private interfaces",
+ "name": "privatemtu",
+ "type": "integer"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
"type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the first IPv6 DNS for the network",
+ "name": "ip6dns1",
"type": "string"
},
{
- "description": "an optional field, whether to the display the network to the end user or not.",
- "name": "displaynetwork",
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
"type": "boolean"
},
{
- "description": "the ID of the Network associated with this private gateway",
- "name": "associatednetworkid",
+ "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
+ "name": "broadcasturi",
"type": "string"
},
{
- "description": "state of the network",
- "name": "state",
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
"type": "string"
},
{
- "description": "ACL name associated with the VPC network",
- "name": "aclname",
- "type": "string"
+ "description": "if network offering supports vm autoscaling feature",
+ "name": "supportsvmautoscaling",
+ "type": "boolean"
},
{
- "description": "The vlan of the network. This parameter is visible to ROOT admins only",
- "name": "vlan",
+ "description": "the network's netmask",
+ "name": "netmask",
"type": "string"
},
{
- "description": "the domain id of the network owner",
- "name": "domainid",
+ "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
+ "name": "networkcidr",
"type": "string"
},
{
- "description": "the details of the network",
- "name": "details",
- "type": "map"
+ "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
+ "name": "reservediprange",
+ "type": "string"
},
{
- "description": "availability of the network offering the network is created from",
- "name": "networkofferingavailability",
+ "description": "the id of the network",
+ "name": "id",
"type": "string"
},
{
- "description": "zone id of the network",
- "name": "zoneid",
- "type": "string"
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
},
{
- "description": "related to what other network configuration",
- "name": "related",
- "type": "string"
+ "description": "true if network is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
},
{
- "description": "the network domain",
- "name": "networkdomain",
+ "description": "the second IPv4 DNS for the network",
+ "name": "dns2",
"type": "string"
},
{
- "description": "acl type - access type to the network",
- "name": "acltype",
+ "description": "the name of the network",
+ "name": "name",
"type": "string"
},
{
- "description": "list networks that are persistent",
- "name": "ispersistent",
- "type": "boolean"
+ "description": "the second IPv6 DNS for the network",
+ "name": "ip6dns2",
+ "type": "string"
},
{
- "description": "MTU configured on the network VR's public facing interfaces",
- "name": "publicmtu",
- "type": "integer"
+ "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
+ "name": "cidr",
+ "type": "string"
},
{
- "description": "true if network is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
+ "description": "path of the Domain the network belongs to",
+ "name": "domainpath",
+ "type": "string"
},
{
- "description": "Name of the VPC to which this network belongs",
- "name": "vpcname",
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
"type": "string"
},
{
- "description": "The internet protocol of network offering",
- "name": "internetprotocol",
+ "description": "the domain id of the network owner",
+ "name": "domainid",
"type": "string"
},
- {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "true if guest network default egress policy is allow; false if default egress policy is deny",
+ "name": "egressdefaultpolicy",
+ "type": "boolean"
},
{
- "description": "the owner of the network",
- "name": "account",
+ "description": "The external id of the network",
+ "name": "externalid",
"type": "string"
},
{
- "description": "list networks available for vm deployment",
- "name": "canusefordeploy",
- "type": "boolean"
+ "description": "the traffic type of the network",
+ "name": "traffictype",
+ "type": "string"
},
{
"description": "the total number of network traffic bytes received",
@@ -5385,13 +5276,13 @@
"type": "long"
},
{
- "description": "display text of the network offering the network is created from",
- "name": "networkofferingdisplaytext",
+ "description": "state of the network",
+ "name": "state",
"type": "string"
},
{
- "description": "The external id of the network",
- "name": "externalid",
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
"type": "string"
},
{
@@ -5400,23 +5291,38 @@
"type": "boolean"
},
{
- "description": "true if network supports specifying ip ranges, false otherwise",
- "name": "specifyipranges",
- "type": "boolean"
+ "description": "name of the network offering the network is created from",
+ "name": "networkofferingname",
+ "type": "string"
},
{
- "description": "true if network can span multiple zones",
- "name": "strechedl2subnet",
- "type": "boolean"
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
},
{
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
},
{
- "description": "name of the network offering the network is created from",
- "name": "networkofferingname",
+ "description": "the ID of the Network associated with this private gateway",
+ "name": "associatednetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the displaytext of the network",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "related to what other network configuration",
+ "name": "related",
"type": "string"
},
{
@@ -5433,38 +5339,38 @@
"name": "provider",
"response": [
{
- "description": "services for this provider",
- "name": "servicelist",
- "type": "list"
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
- "type": "string"
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
},
{
- "description": "uuid of the network provider",
- "name": "id",
- "type": "string"
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
},
{
"description": "the provider name",
"name": "name",
"type": "string"
},
- {
- "description": "true if individual services can be enabled/disabled",
- "name": "canenableindividualservice",
- "type": "boolean"
- },
{
"description": "the destination physical network",
"name": "destinationphysicalnetworkid",
"type": "string"
},
{
- "description": "state of the network provider",
- "name": "state",
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
"type": "string"
}
],
@@ -5474,6 +5380,11 @@
"description": "the list of capabilities",
"name": "capability",
"response": [
+ {
+ "description": "the capability value",
+ "name": "value",
+ "type": "string"
+ },
{
"description": "can this service capability value can be choosable while creatine network offerings",
"name": "canchooseservicecapability",
@@ -5483,11 +5394,6 @@
"description": "the capability name",
"name": "name",
"type": "string"
- },
- {
- "description": "the capability value",
- "name": "value",
- "type": "string"
}
],
"type": "list"
@@ -5496,59 +5402,153 @@
"type": "list"
},
{
- "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
- "name": "zonesnetworkspans",
- "type": "set"
+ "description": "The routing mode of network offering",
+ "name": "ip6routing",
+ "type": "string"
},
{
- "description": "true if guest network default egress policy is allow; false if default egress policy is deny",
- "name": "egressdefaultpolicy",
- "type": "boolean"
+ "description": "MTU configured on the network VR's public facing interfaces",
+ "name": "publicmtu",
+ "type": "integer"
},
{
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "ACL name associated with the VPC network",
+ "name": "aclname",
"type": "string"
},
+ {},
{
- "description": "true network requires restart",
- "name": "restartrequired",
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
+ "type": "string"
+ },
+ {
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
"type": "boolean"
},
{
- "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes",
- "name": "reservediprange",
+ "description": "the ID of the Network associated with this network",
+ "name": "associatednetworkid",
"type": "string"
},
- {},
{
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
+ "description": "display text of the network offering the network is created from",
+ "name": "networkofferingdisplaytext",
"type": "string"
},
{
- "description": "ACL Id associated with the VPC network",
- "name": "aclid",
+ "description": "the first IPv4 DNS for the network",
+ "name": "dns1",
"type": "string"
},
{
- "description": "The routes for the network to ease adding route in upstream router",
- "name": "ip6routes",
- "type": "set"
+ "description": "The internet protocol of network offering",
+ "name": "internetprotocol",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "List dedicated zones.",
+ "isasync": false,
+ "name": "listDedicatedZones",
+ "params": [
+ {
+ "description": "the ID of the Zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
},
{
- "description": "the date this network was created",
- "name": "created",
- "type": "date"
+ "description": "the name of the account associated with the zone. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
},
{
- "description": "the id of the network",
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the domain associated with the zone",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list dedicated zones by affinity group",
+ "length": 255,
+ "name": "affinitygroupid",
+ "related": "createAffinityGroup,listAffinityGroups",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "related": "dedicateZone",
+ "response": [
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the dedicated resource",
"name": "id",
"type": "string"
},
{
- "description": "the name of the Network associated with this private gateway",
- "name": "associatednetwork",
+ "description": "the Account Id to which the Zone is dedicated",
+ "name": "accountid",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "the Dedication Affinity Group ID of the zone",
+ "name": "affinitygroupid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID to which the Zone is dedicated",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the Name of the Zone",
+ "name": "zonename",
"type": "string"
}
]
@@ -5568,21 +5568,12 @@
],
"related": "",
"response": [
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
{
"description": "the current available space of the pool",
"name": "size",
"type": "long"
},
- {
- "description": "the name of the storage pool",
- "name": "name",
- "type": "string"
- },
+ {},
{
"description": "default gateway of the pool",
"name": "gateway",
@@ -5590,14 +5581,9 @@
},
{},
{
- "description": "available iops of the pool",
- "name": "maxiops",
- "type": "long"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the ID of the storage pool",
+ "name": "id",
+ "type": "string"
},
{
"description": "the state of the storage pool",
@@ -5605,16 +5591,30 @@
"type": "string"
},
{
- "description": "the ID of the storage pool",
- "name": "id",
+ "description": "controller of the pool",
+ "name": "controllerid",
"type": "string"
},
{
- "description": "controller of the pool",
- "name": "controllerid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
- {}
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the storage pool",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "available iops of the pool",
+ "name": "maxiops",
+ "type": "long"
+ }
]
},
{
@@ -5632,28 +5632,28 @@
}
],
"response": [
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
{},
- {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- }
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {}
],
"since": "4.17"
},
@@ -5663,34 +5663,34 @@
"name": "updatePodManagementNetworkIpRange",
"params": [
{
- "description": "The new starting IP address.",
+ "description": "The new ending IP address.",
"length": 255,
- "name": "newstartip",
+ "name": "newendip",
"required": false,
"type": "string"
},
{
- "description": "The new ending IP address.",
+ "description": "The new starting IP address.",
"length": 255,
- "name": "newendip",
+ "name": "newstartip",
"required": false,
"type": "string"
},
{
- "description": "The current starting IP address.",
+ "description": "UUID of POD, where the IP range belongs to.",
"length": 255,
- "name": "currentstartip",
+ "name": "podid",
"related": "listPods,updatePod,createManagementNetworkIpRange",
"required": true,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "UUID of POD, where the IP range belongs to.",
+ "description": "The current starting IP address.",
"length": 255,
- "name": "podid",
+ "name": "currentstartip",
"related": "listPods,updatePod,createManagementNetworkIpRange",
"required": true,
- "type": "uuid"
+ "type": "string"
},
{
"description": "The current ending IP address.",
@@ -5702,27 +5702,27 @@
}
],
"response": [
+ {},
{},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
}
],
"since": "4.16.0.0"
@@ -5732,25 +5732,17 @@
"isasync": false,
"name": "listTungstenFabricLBHealthMonitor",
"params": [
- {
- "description": "the ID of lb rule",
- "length": 255,
- "name": "lbruleid",
- "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules",
- "required": true,
- "type": "uuid"
- },
{
"description": "",
"length": 255,
- "name": "pagesize",
+ "name": "page",
"required": false,
"type": "integer"
},
{
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
@@ -5760,33 +5752,46 @@
"name": "keyword",
"required": false,
"type": "string"
+ },
+ {
+ "description": "the ID of lb rule",
+ "length": 255,
+ "name": "lbruleid",
+ "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule",
+ "required": true,
+ "type": "uuid"
}
],
"related": "updateTungstenFabricLBHealthMonitor",
"response": [
{
- "description": "the health monitor ID",
- "name": "id",
- "type": "long"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{
- "description": "Tungsten-Fabric provider zone name",
- "name": "zonename",
- "type": "string"
+ "description": "the health monitor timeout",
+ "name": "timeout",
+ "type": "int"
},
{
- "description": "the health monitor retry",
- "name": "retry",
+ "description": "the health monitor interval",
+ "name": "interval",
"type": "int"
},
{
- "description": "the health monitor http method",
- "name": "httpmethod",
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the health monitor url path",
+ "name": "urlpath",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "Tungsten-Fabric provider zone name",
+ "name": "zonename",
"type": "string"
},
{
@@ -5794,48 +5799,43 @@
"name": "uuid",
"type": "string"
},
+ {},
{
- "description": "the health monitor url path",
- "name": "urlpath",
- "type": "string"
+ "description": "the health monitor retry",
+ "name": "retry",
+ "type": "int"
},
{
- "description": "the health monitor expected code",
- "name": "expectedcode",
+ "description": "the health monitor type",
+ "name": "type",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "the health monitor timeout",
- "name": "timeout",
- "type": "int"
+ "description": "the health monitor ID",
+ "name": "id",
+ "type": "long"
},
{
"description": "Tungsten-Fabric provider zone id",
"name": "zoneid",
"type": "long"
},
- {},
- {
- "description": "the health monitor interval",
- "name": "interval",
- "type": "int"
- },
{
"description": "the LB rule ID",
"name": "lbruleid",
"type": "string"
},
+ {},
{
- "description": "the health monitor type",
- "name": "type",
+ "description": "the health monitor http method",
+ "name": "httpmethod",
"type": "string"
},
- {}
+ {
+ "description": "the health monitor expected code",
+ "name": "expectedcode",
+ "type": "string"
+ }
]
},
{
@@ -5843,6 +5843,14 @@
"isasync": true,
"name": "updateFirewallRule",
"params": [
+ {
+ "description": "the ID of the firewall rule",
+ "length": 255,
+ "name": "id",
+ "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule",
+ "required": true,
+ "type": "uuid"
+ },
{
"description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
"length": 255,
@@ -5851,14 +5859,6 @@
"since": "4.4",
"type": "string"
},
- {
- "description": "the ID of the firewall rule",
- "length": 255,
- "name": "id",
- "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules",
- "required": true,
- "type": "uuid"
- },
{
"description": "an optional field, whether to the display the rule to the end user or not",
"length": 255,
@@ -5871,57 +5871,124 @@
"related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule",
"response": [
{
- "description": "the public ip address id for the firewall rule",
- "name": "ipaddressid",
+ "description": "the traffic type for the firewall rule",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "type of the icmp message being sent",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the network id of the firewall rule",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
+ "type": "string"
+ },
+ {
+ "description": "the ending port of firewall rule's port range",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the state of the rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the firewall rule",
+ "name": "id",
"type": "string"
},
+ {
+ "description": "the protocol of the firewall rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
{
"description": "error code for this icmp message",
"name": "icmpcode",
"type": "integer"
},
+ {
+ "description": "the starting port of firewall rule's port range",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the public ip address id for the firewall rule",
+ "name": "ipaddressid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
+ "name": "destcidrlist",
+ "type": "string"
+ },
{
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "tag value",
- "name": "value",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
@@ -5930,84 +5997,17 @@
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
}
],
"type": "list"
},
- {
- "description": "the starting port of firewall rule's port range",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the ID of the firewall rule",
- "name": "id",
- "type": "string"
- },
{
"description": "the public ip address for the firewall rule",
"name": "ipaddress",
"type": "string"
- },
- {
- "description": "the state of the rule",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the traffic type for the firewall rule",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "type of the icmp message being sent",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
- "name": "destcidrlist",
- "type": "string"
- },
- {
- "description": "the ending port of firewall rule's port range",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
- "name": "cidrlist",
- "type": "string"
- },
- {
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
- {},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {},
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the network id of the firewall rule",
- "name": "networkid",
- "type": "string"
- },
- {
- "description": "the protocol of the firewall rule",
- "name": "protocol",
- "type": "string"
}
],
"since": "4.4"
@@ -6019,23 +6019,23 @@
"params": [],
"related": "",
"response": [
- {
- "description": "is quota service enabled",
- "name": "isenabled",
- "type": "boolean"
- },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{},
+ {
+ "description": "is quota service enabled",
+ "name": "isenabled",
+ "type": "boolean"
+ },
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {}
+ }
],
"since": "4.7.0"
},
@@ -6054,43 +6054,112 @@
}
],
"response": [
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
{},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "any text associated with the success or failure",
- "name": "displaytext",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
+ ],
+ "since": "4.19.0"
+ },
+ {
+ "description": "Lists all quota email templates",
+ "isasync": false,
+ "name": "quotaEmailTemplateList",
+ "params": [
+ {
+ "description": "List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY",
+ "length": 255,
+ "name": "templatetype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ }
+ ],
+ "related": "",
+ "response": [
+ {
+ "description": "The quota email template locale",
+ "name": "locale",
"type": "string"
},
{},
+ {
+ "description": "The quota email template subject",
+ "name": "templatesubject",
+ "type": "string"
+ },
+ {
+ "description": "Last date/time when template was updated",
+ "name": "last_updated",
+ "type": "date"
+ },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- }
+ "description": "The quota email template content",
+ "name": "templatebody",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "Template type",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {}
],
- "since": "4.19.0"
+ "since": "4.7.0"
},
{
"description": "Deletes account from the project",
"isasync": true,
"name": "deleteAccountFromProject",
"params": [
- {
- "description": "name of the account to be removed from the project",
- "length": 255,
- "name": "account",
- "required": true,
- "type": "string"
- },
{
"description": "ID of the project to remove the account from",
"length": 255,
@@ -6098,31 +6167,38 @@
"related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "name of the account to be removed from the project",
+ "length": 255,
+ "name": "account",
+ "required": true,
+ "type": "string"
}
],
"response": [
{},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
},
{
"description": "true if operation is executed successfully",
"name": "success",
"type": "boolean"
},
- {
- "description": "any text associated with the success or failure",
- "name": "displaytext",
- "type": "string"
- },
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
- {}
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
],
"since": "3.0.0"
},
@@ -6142,11 +6218,6 @@
],
"related": "",
"response": [
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
{},
{
"description": "the UUID of the latest async job acting on this object",
@@ -6158,7 +6229,12 @@
"name": "name",
"type": "string"
},
- {}
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
]
},
{
@@ -6173,6 +6249,13 @@
"required": false,
"type": "map"
},
+ {
+ "description": "Unique display name for Guest OS",
+ "length": 255,
+ "name": "osdisplayname",
+ "required": true,
+ "type": "string"
+ },
{
"description": "UUID of the Guest OS",
"length": 255,
@@ -6187,36 +6270,34 @@
"name": "forDisplay",
"required": false,
"type": "boolean"
- },
- {
- "description": "Unique display name for Guest OS",
- "length": 255,
- "name": "osdisplayname",
- "required": true,
- "type": "string"
}
],
"related": "listOsTypes,addGuestOs",
"response": [
{
- "description": "the name of the OS category",
- "name": "oscategoryname",
+ "description": "the name/description of the OS type",
+ "name": "description",
"type": "string"
},
- {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "is the guest OS visible for the users",
+ "name": "fordisplay",
+ "type": "boolean"
},
{
- "description": "the name of the OS type",
- "name": "name",
+ "description": "the ID of the OS type",
+ "name": "id",
"type": "string"
},
{
- "description": "is the guest OS visible for the users",
- "name": "fordisplay",
+ "description": "the name of the OS category",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "is the guest OS user defined",
+ "name": "isuserdefined",
"type": "boolean"
},
{
@@ -6224,26 +6305,21 @@
"name": "jobid",
"type": "string"
},
- {
- "description": "the ID of the OS type",
- "name": "id",
- "type": "string"
- },
{
"description": "the ID of the OS category",
"name": "oscategoryid",
"type": "string"
},
- {},
{
- "description": "the name/description of the OS type",
- "name": "description",
+ "description": "the name of the OS type",
+ "name": "name",
"type": "string"
},
+ {},
{
- "description": "is the guest OS user defined",
- "name": "isuserdefined",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
],
"since": "4.4.0"
@@ -6254,18 +6330,25 @@
"name": "listGuestVlans",
"params": [
{
- "description": "limits search results to allocated guest vlan. false by default.",
+ "description": "",
"length": 255,
- "name": "allocatedonly",
+ "name": "pagesize",
"required": false,
- "type": "boolean"
+ "type": "integer"
},
{
- "description": "list guest vlan by vnet",
+ "description": "",
"length": 255,
- "name": "vnet",
+ "name": "page",
"required": false,
- "type": "string"
+ "type": "integer"
+ },
+ {
+ "description": "limits search results to allocated guest vlan. false by default.",
+ "length": 255,
+ "name": "allocatedonly",
+ "required": false,
+ "type": "boolean"
},
{
"description": "list guest vlan by id",
@@ -6282,13 +6365,6 @@
"required": false,
"type": "uuid"
},
- {
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
{
"description": "list guest vlan by physical network",
"length": 255,
@@ -6298,45 +6374,50 @@
"type": "uuid"
},
{
- "description": "",
+ "description": "list guest vlan by vnet",
"length": 255,
- "name": "pagesize",
+ "name": "vnet",
"required": false,
- "type": "integer"
+ "type": "string"
},
{
- "description": "",
+ "description": "List by keyword",
"length": 255,
- "name": "page",
+ "name": "keyword",
"required": false,
- "type": "integer"
+ "type": "string"
}
],
"related": "",
"response": [
{
- "description": "the zone ID of the guest VLAN range",
- "name": "zoneid",
+ "description": "the guest VLAN",
+ "name": "vlan",
"type": "string"
},
+ {
+ "description": "true if the guest VLAN is dedicated to the account",
+ "name": "isdedicated",
+ "type": "boolean"
+ },
{
"description": "the domain ID of the guest VLAN range",
"name": "domainid",
"type": "string"
},
{
- "description": "the physical network name of the guest VLAN range",
- "name": "physicalnetworkname",
+ "description": "the project name of the guest VLAN range",
+ "name": "project",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "date the guest VLAN was taken",
+ "name": "taken",
+ "type": "date"
},
{
- "description": "the guest VLAN",
- "name": "vlan",
+ "description": "the account of the guest VLAN range",
+ "name": "account",
"type": "string"
},
{
@@ -6345,23 +6426,18 @@
"type": "string"
},
{
- "description": "the zone name of the guest VLAN range",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the physical network ID of the guest VLAN range",
- "name": "physicalnetworkid",
+ "description": "the allocation state of the guest VLAN",
+ "name": "allocationstate",
"type": "string"
},
{
- "description": "the account of the guest VLAN range",
- "name": "account",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the zone ID of the guest VLAN range",
+ "name": "zoneid",
"type": "string"
},
{
@@ -6369,15 +6445,24 @@
"name": "id",
"type": "long"
},
+ {
+ "description": "the physical network ID of the guest VLAN range",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
{
"description": "the domain name of the guest VLAN range",
"name": "domain",
"type": "string"
},
- {},
{
- "description": "the project name of the guest VLAN range",
- "name": "project",
+ "description": "the physical network name of the guest VLAN range",
+ "name": "physicalnetworkname",
+ "type": "string"
+ },
+ {
+ "description": "the zone name of the guest VLAN range",
+ "name": "zonename",
"type": "string"
},
{
@@ -6386,20 +6471,11 @@
"type": "list"
},
{
- "description": "the allocation state of the guest VLAN",
- "name": "allocationstate",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
- {
- "description": "true if the guest VLAN is dedicated to the account",
- "name": "isdedicated",
- "type": "boolean"
- },
- {
- "description": "date the guest VLAN was taken",
- "name": "taken",
- "type": "date"
- },
+ {},
{}
],
"since": "4.17.0"
@@ -6410,11 +6486,19 @@
"name": "updateResourceLimit",
"params": [
{
- "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. T [...]
+ "description": "Update resource limits for project",
"length": 255,
- "name": "resourcetype",
- "required": true,
- "type": "integer"
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": " Maximum resource limit.",
+ "length": 255,
+ "name": "max",
+ "required": false,
+ "type": "long"
},
{
"description": "Update resource for a specified account. Must be used with the domainId parameter.",
@@ -6432,75 +6516,67 @@
"type": "uuid"
},
{
- "description": " Maximum resource limit.",
- "length": 255,
- "name": "max",
- "required": false,
- "type": "long"
- },
- {
- "description": "Update resource limits for project",
+ "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. T [...]
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
- "required": false,
- "type": "uuid"
+ "name": "resourcetype",
+ "required": true,
+ "type": "integer"
}
],
"related": "listResourceLimits",
"response": [
- {
- "description": "the project name of the resource limit",
- "name": "project",
- "type": "string"
- },
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.",
- "name": "resourcetype",
+ "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.",
+ "name": "resourcetypename",
"type": "string"
},
{
- "description": "the maximum number of the resource. A -1 means the resource currently has no limit.",
- "name": "max",
- "type": "long"
+ "description": "the domain ID of the resource limit",
+ "name": "domainid",
+ "type": "string"
},
{
- "description": "the account of the resource limit",
- "name": "account",
+ "description": "the project name of the resource limit",
+ "name": "project",
"type": "string"
},
{
- "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.",
- "name": "resourcetypename",
+ "description": "the domain name of the resource limit",
+ "name": "domain",
"type": "string"
},
- {},
- {},
{
- "description": "the project id of the resource limit",
- "name": "projectid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
+ {},
{
- "description": "the domain ID of the resource limit",
- "name": "domainid",
+ "description": "the account of the resource limit",
+ "name": "account",
"type": "string"
},
{
- "description": "the domain name of the resource limit",
- "name": "domain",
+ "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the project id of the resource limit",
+ "name": "projectid",
"type": "string"
- }
+ },
+ {
+ "description": "the maximum number of the resource. A -1 means the resource currently has no limit.",
+ "name": "max",
+ "type": "long"
+ },
+ {}
]
},
{
@@ -6518,12 +6594,18 @@
}
],
"response": [
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
{},
{
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -6533,13 +6615,7 @@
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
- },
- {
- "description": "true if operation is executed successfully",
- "name": "success",
- "type": "boolean"
- },
- {}
+ }
]
},
{
@@ -6548,11 +6624,18 @@
"name": "listHostsMetrics",
"params": [
{
- "description": "if true, list only hosts dedicated to HA",
+ "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
"length": 255,
- "name": "hahost",
+ "name": "hypervisor",
"required": false,
- "type": "boolean"
+ "type": "string"
+ },
+ {
+ "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]",
+ "length": 255,
+ "name": "resourcestate",
+ "required": false,
+ "type": "string"
},
{
"description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM",
@@ -6563,40 +6646,40 @@
"type": "uuid"
},
{
- "description": "",
+ "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
"length": 255,
- "name": "pagesize",
+ "name": "details",
"required": false,
- "type": "integer"
+ "type": "list"
},
{
- "description": "the name of the host",
+ "description": "the host type",
"length": 255,
- "name": "name",
+ "name": "type",
"required": false,
"type": "string"
},
{
- "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
+ "description": "the Zone ID for the host",
"length": 255,
- "name": "hypervisor",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "",
+ "description": "if true, list only hosts dedicated to HA",
"length": 255,
- "name": "page",
+ "name": "hahost",
"required": false,
- "type": "integer"
+ "type": "boolean"
},
{
- "description": "lists hosts existing in particular cluster",
+ "description": "",
"length": 255,
- "name": "clusterid",
- "related": "addCluster,listClusters,updateCluster",
+ "name": "pagesize",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
"description": "the state of the host",
@@ -6613,101 +6696,94 @@
"type": "boolean"
},
{
- "description": "the Pod ID for the host",
+ "description": "the id of the host",
"length": 255,
- "name": "podid",
- "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "name": "id",
+ "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost",
"required": false,
"type": "uuid"
},
{
- "description": "the host type",
- "length": 255,
- "name": "type",
- "required": false,
- "type": "string"
- },
- {
- "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
+ "description": "",
"length": 255,
- "name": "details",
+ "name": "page",
"required": false,
- "type": "list"
+ "type": "integer"
},
{
- "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]",
+ "description": "the Pod ID for the host",
"length": 255,
- "name": "outofbandmanagementpowerstate",
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "List by keyword",
+ "description": "the name of the host",
"length": 255,
- "name": "keyword",
+ "name": "name",
"required": false,
"type": "string"
},
{
- "description": "the id of the host",
+ "description": "lists hosts existing in particular cluster",
"length": 255,
- "name": "id",
- "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "name": "clusterid",
+ "related": "addCluster,listClusters,updateCluster",
"required": false,
"type": "uuid"
},
{
- "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]",
+ "description": "List by keyword",
"length": 255,
- "name": "resourcestate",
+ "name": "keyword",
"required": false,
"type": "string"
},
{
- "description": "the Zone ID for the host",
+ "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "outofbandmanagementpowerstate",
"required": false,
- "type": "uuid"
+ "type": "string"
}
],
"related": "",
"response": [
{
- "description": "memory usage disable threshold exceeded",
- "name": "memorydisablethreshold",
- "type": "boolean"
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "type": "string"
},
{
- "description": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
- "type": "boolean"
+ "description": "instances on the host",
+ "name": "instances",
+ "type": "string"
},
{
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
+ "type": "string"
},
{
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
+ "description": "memory allocated disable threshold exceeded",
+ "name": "memoryallocateddisablethreshold",
"type": "boolean"
},
{
- "description": "the Zone ID of the host",
- "name": "zoneid",
+ "description": "system vm instances on the host",
+ "name": "systeminstances",
"type": "string"
},
{
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
+ "type": "string"
},
{
- "description": "the amount of the host's memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
- "type": "long"
+ "description": "true if the host supports encryption",
+ "name": "encryptionsupported",
+ "type": "boolean"
},
{
"description": "the amount of the host's memory currently allocated",
@@ -6715,130 +6791,134 @@
"type": "long"
},
{
- "description": "instances on the host",
- "name": "instances",
- "type": "string"
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
},
{
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
- "type": "long"
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
},
{
- "description": "the last time this host was annotated",
- "name": "lastannotated",
- "type": "date"
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the total memory used in GiB",
+ "name": "memoryusedgb",
"type": "string"
},
{
- "description": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
},
{
- "description": "the average cpu load the last minute",
- "name": "cpuloadaverage",
- "type": "double"
+ "description": "cpu allocated disable threshold exceeded",
+ "name": "cpuallocateddisablethreshold",
+ "type": "boolean"
},
{
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
+ "description": "memory usage disable threshold exceeded",
+ "name": "memorydisablethreshold",
+ "type": "boolean"
},
{
- "description": "capabilities of the host",
- "name": "capabilities",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "events available for the host",
- "name": "events",
- "type": "string"
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
},
{
- "description": "out-of-band management power state",
- "name": "powerstate",
- "type": "powerstate"
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
},
{
- "description": "the OS category name of the host",
- "name": "oscategoryname",
+ "description": "the average cpu load the last minute",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
"type": "string"
},
{
- "description": "the total memory allocated in GiB",
- "name": "memoryallocatedgb",
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
"type": "string"
},
{
- "description": "cpu allocated disable threshold exceeded",
- "name": "cpuallocateddisablethreshold",
+ "description": "Whether the informed tag is a JS interpretable rule or not.",
+ "name": "istagarule",
"type": "boolean"
},
{
- "description": "the hypervisor version",
- "name": "hypervisorversion",
+ "description": "the total memory capacity in GiB",
+ "name": "memorytotalgb",
"type": "string"
},
{
- "description": "network read in GiB",
- "name": "networkread",
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
"type": "string"
},
{
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "name": "hasenoughcapacity",
+ "description": "cpu allocated notification threshold exceeded",
+ "name": "cpuallocatedthreshold",
"type": "boolean"
},
{
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
"type": "long"
},
{
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
+ "description": "the total cpu used in Ghz",
+ "name": "cpuusedghz",
+ "type": "string"
},
{
- "description": "the amount of the host's CPU currently allocated in MHz",
- "name": "cpuallocatedvalue",
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
"type": "string"
},
{
- "description": "the Zone name of the host",
- "name": "zonename",
- "type": "string"
+ "description": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
},
{
- "description": "the total memory capacity in GiB",
- "name": "memorytotalgb",
+ "description": "the total cpu allocated in Ghz",
+ "name": "cpuallocatedghz",
"type": "string"
},
- {},
{
- "description": "the name of the host",
- "name": "name",
- "type": "string"
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
},
{
- "description": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
+ "description": "memory allocated notification threshold exceeded",
+ "name": "memoryallocatedthreshold",
+ "type": "boolean"
},
{
- "description": "memory allocated disable threshold exceeded",
- "name": "memoryallocateddisablethreshold",
- "type": "boolean"
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
},
{
"description": "the OS category ID of the host",
@@ -6846,222 +6926,180 @@
"type": "string"
},
{
- "description": "the total cpu allocated in Ghz",
- "name": "cpuallocatedghz",
- "type": "string"
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
- "type": "long"
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
},
{
- "description": "comma-separated list of tags for the host",
- "name": "hosttags",
+ "description": "the admin that annotated this host",
+ "name": "username",
"type": "string"
},
{
- "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the total cpu capacity in Ghz",
+ "name": "cputotalghz",
"type": "string"
},
{
- "description": "the total disk size of the host",
- "name": "disksizetotal",
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
"type": "long"
},
{
- "description": "the last annotation set on this host by an admin",
- "name": "annotation",
+ "description": "the ID of the host",
+ "name": "id",
"type": "string"
},
{
- "description": "network write in GiB",
- "name": "networkwrite",
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
"type": "string"
},
{
- "description": "memory usage notification threshold exceeded",
- "name": "memorythreshold",
+ "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
+ "name": "suitableformigration",
"type": "boolean"
},
{
- "description": "GPU cards present in the host",
- "name": "gpugroup",
- "response": [
- {
- "description": "the list of enabled vGPUs",
- "name": "vgpu",
- "response": [
- {
- "description": "Model Name of vGPU",
- "name": "vgputype",
- "type": "string"
- },
- {
- "description": "Maximum X resolution per display",
- "name": "maxresolutionx",
- "type": "long"
- },
- {
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
- "type": "long"
- },
- {
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "name": "maxvgpuperpgpu",
- "type": "long"
- },
- {
- "description": "Maximum displays per user",
- "name": "maxheads",
- "type": "long"
- },
- {
- "description": "Video RAM for this vGPU type",
- "name": "videoram",
- "type": "long"
- },
- {
- "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
- "name": "remainingcapacity",
- "type": "long"
- },
- {
- "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
- "name": "maxcapacity",
- "type": "long"
- }
- ],
- "type": "list"
- },
- {
- "description": "GPU cards present in the host",
- "name": "gpugroupname",
- "type": "string"
- }
- ],
- "type": "list"
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
},
{
- "description": "the host type",
- "name": "type",
- "type": "type"
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
},
{
- "description": "cpu usage notification threshold exceeded",
- "name": "cputhreshold",
- "type": "boolean"
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
},
+ {},
{
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
- "type": "long"
+ "description": "out-of-band management power state",
+ "name": "powerstate",
+ "type": "powerstate"
},
{
- "description": "the total memory used in GiB",
- "name": "memoryusedgb",
+ "description": "the host hypervisor",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the total cpu capacity in Ghz",
- "name": "cputotalghz",
+ "description": "events available for the host",
+ "name": "events",
"type": "string"
},
{
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "type": "string"
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
},
{
- "description": "cpu usage disable threshold exceeded",
- "name": "cpudisablethreshold",
- "type": "boolean"
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
},
{
- "description": "cpu allocated notification threshold exceeded",
- "name": "cpuallocatedthreshold",
- "type": "boolean"
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
},
{
- "description": "the cluster ID of the host",
- "name": "clusterid",
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
"type": "string"
},
{
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the Pod name of the host",
- "name": "podname",
- "type": "string"
+ "description": "cpu usage disable threshold exceeded",
+ "name": "cpudisablethreshold",
+ "type": "boolean"
},
{
- "description": "the Pod ID of the host",
- "name": "podid",
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "true if the host supports encryption",
- "name": "encryptionsupported",
+ "description": "cpu usage notification threshold exceeded",
+ "name": "cputhreshold",
"type": "boolean"
},
{
- "description": "the management server ID of the host",
- "name": "managementserverid",
- "type": "string"
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
... 188183 lines suppressed ...