You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ro...@apache.org on 2021/09/20 08:09:27 UTC
[cloudstack-go] branch main updated: generate: update listApis
against 4.15.2
This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack-go.git
The following commit(s) were added to refs/heads/main by this push:
new d6d4529 generate: update listApis against 4.15.2
d6d4529 is described below
commit d6d45296f19abc1c72ee8d76b9da8a4a91f148b0
Author: Rohit Yadav <ro...@shapeblue.com>
AuthorDate: Mon Sep 20 13:39:09 2021 +0530
generate: update listApis against 4.15.2
Signed-off-by: Rohit Yadav <ro...@shapeblue.com>
---
generate/listApis.json | 112587 ++++++++++++++++++++++------------------------
1 file changed, 54494 insertions(+), 58093 deletions(-)
diff --git a/generate/listApis.json b/generate/listApis.json
index e53f1b8..6d97e6b 100644
--- a/generate/listApis.json
+++ b/generate/listApis.json
@@ -6,20 +6,6 @@
"name": "createVPCOffering",
"params": [
{
- "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",
- "length": 255,
- "name": "serviceproviderlist",
- "required": false,
- "type": "map"
- },
- {
"description": "the ID of the containing zone(s), null for public offerings",
"length": 255,
"name": "zoneid",
@@ -29,12 +15,11 @@
"type": "list"
},
{
- "description": "the ID of the containing domain(s), null for public offerings",
+ "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "serviceproviderlist",
"required": false,
- "type": "list"
+ "type": "map"
},
{
"description": "the display text of the vpc offering",
@@ -59,51 +44,47 @@
"type": "map"
},
{
+ "description": "the name of the vpc offering",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "the ID of the service offering for the VPC router appliance",
"length": 255,
"name": "serviceofferingid",
"related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the ID of the containing domain(s), null for public offerings",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "list"
}
],
"related": "updateVPCOffering,listVPCOfferings",
"response": [
{
- "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "zone",
- "type": "string"
- },
- {
- "description": "true if vpc offering is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the id of the vpc offering",
- "name": "id",
+ "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 name of the vpc offering",
"name": "name",
"type": "string"
},
{
- "description": " indicated if the offering can support region level vpc",
- "name": "supportsregionLevelvpc",
- "type": "boolean"
- },
- {
"description": "the list of supported services",
"name": "service",
"response": [
{
- "description": "the service name",
- "name": "name",
- "type": "string"
- },
- {
"description": "the service provider name",
"name": "provider",
"response": [
@@ -113,23 +94,23 @@
"type": "list"
},
{
- "description": "the provider name",
- "name": "name",
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
"type": "string"
},
{
- "description": "the physical network this belongs to",
- "name": "physicalnetworkid",
+ "description": "state of the network provider",
+ "name": "state",
"type": "string"
},
{
- "description": "state of the network provider",
- "name": "state",
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
"type": "string"
},
{
- "description": "the destination physical network",
- "name": "destinationphysicalnetworkid",
+ "description": "the provider name",
+ "name": "name",
"type": "string"
},
{
@@ -146,6 +127,11 @@
"type": "list"
},
{
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ },
+ {
"description": "the list of capabilities",
"name": "capability",
"response": [
@@ -155,14 +141,14 @@
"type": "string"
},
{
- "description": "can this service capability value can be choosable while creatine network offerings",
- "name": "canchooseservicecapability",
- "type": "boolean"
- },
- {
"description": "the capability value",
"name": "value",
"type": "string"
+ },
+ {
+ "description": "can this service capability value can be choosable while creatine network offerings",
+ "name": "canchooseservicecapability",
+ "type": "boolean"
}
],
"type": "list"
@@ -171,13 +157,38 @@
"type": "list"
},
{
+ "description": " indicated if the offering can support region level vpc",
+ "name": "supportsregionLevelvpc",
+ "type": "boolean"
+ },
+ {
+ "description": "true if vpc offering is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the id of the vpc offering",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "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 date this vpc offering was created",
"name": "created",
"type": "date"
},
{
- "description": "an alternate display text of the vpc offering.",
- "name": "displaytext",
+ "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domainid",
"type": "string"
},
{
@@ -185,36 +196,25 @@
"name": "jobstatus",
"type": "integer"
},
- {},
{
- "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
- "name": "domainid",
+ "description": "an alternate display text of the vpc offering.",
+ "name": "displaytext",
"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"
},
- {
- "description": "state of the vpc offering. Can be Disabled/Enabled",
- "name": "state",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
+ {},
{
"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",
+ "description": "state of the vpc offering. Can be Disabled/Enabled",
+ "name": "state",
"type": "string"
}
]
@@ -225,37 +225,30 @@
"name": "createPod",
"params": [
{
- "description": "Allocation state of this Pod for allocation of new resources",
+ "description": "the ending IP address for the Pod",
"length": 255,
- "name": "allocationstate",
+ "name": "endip",
"required": false,
"type": "string"
},
{
- "description": "the netmask for the Pod",
- "length": 255,
- "name": "netmask",
- "required": true,
- "type": "string"
- },
- {
- "description": "the gateway for the Pod",
+ "description": "the starting IP address for the Pod",
"length": 255,
- "name": "gateway",
+ "name": "startip",
"required": true,
"type": "string"
},
{
- "description": "the ending IP address for the Pod",
+ "description": "Allocation state of this Pod for allocation of new resources",
"length": 255,
- "name": "endip",
+ "name": "allocationstate",
"required": false,
"type": "string"
},
{
- "description": "the starting IP address for the Pod",
+ "description": "the netmask for the Pod",
"length": 255,
- "name": "startip",
+ "name": "netmask",
"required": true,
"type": "string"
},
@@ -273,83 +266,56 @@
"name": "name",
"required": true,
"type": "string"
+ },
+ {
+ "description": "the gateway for the Pod",
+ "length": 255,
+ "name": "gateway",
+ "required": true,
+ "type": "string"
}
],
"related": "listPods,updatePod,createManagementNetworkIpRange",
"response": [
{
- "description": "the Zone name of the Pod",
- "name": "zonename",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the starting IP for the Pod",
- "name": "startip",
- "type": "list"
- },
- {
- "description": "the ID of the Pod",
- "name": "id",
+ "description": "the gateway of the Pod",
+ "name": "gateway",
"type": "string"
},
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "indicates Vlan ID for the range",
- "name": "vlanid",
- "type": "list"
- },
+ {},
{
"description": "the capacity of the Pod",
"name": "capacity",
"response": [
{
- "description": "the capacity currently in allocated",
- "name": "capacityallocated",
- "type": "long"
- },
- {
- "description": "the capacity type",
- "name": "type",
- "type": "short"
- },
- {
"description": "the Zone ID",
"name": "zoneid",
"type": "string"
},
{
- "description": "the Cluster ID",
- "name": "clusterid",
+ "description": "the Zone name",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the Cluster name",
- "name": "clustername",
+ "description": "the capacity name",
+ "name": "name",
"type": "string"
},
{
- "description": "the capacity currently in use",
- "name": "capacityused",
- "type": "long"
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
},
{
- "description": "the Pod ID",
- "name": "podid",
- "type": "string"
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
},
{
- "description": "the Zone name",
- "name": "zonename",
- "type": "string"
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
},
{
"description": "the percentage of capacity currently in use",
@@ -357,59 +323,93 @@
"type": "string"
},
{
- "description": "the Pod name",
- "name": "podname",
+ "description": "the capacity type",
+ "name": "type",
+ "type": "short"
+ },
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
"type": "string"
},
{
- "description": "the total capacity available",
- "name": "capacitytotal",
+ "description": "the capacity currently in use",
+ "name": "capacityused",
"type": "long"
},
{
- "description": "the capacity name",
- "name": "name",
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID",
+ "name": "podid",
"type": "string"
}
],
"type": "list"
},
+ {},
+ {
+ "description": "the ending IP for the Pod",
+ "name": "endip",
+ "type": "list"
+ },
+ {
+ "description": "the allocation state of the Pod",
+ "name": "allocationstate",
+ "type": "string"
+ },
{
"description": "the netmask of the Pod",
"name": "netmask",
"type": "string"
},
{
- "description": "the Zone ID of the Pod",
- "name": "zoneid",
+ "description": "the Zone name of the Pod",
+ "name": "zonename",
"type": "string"
},
- {},
{
- "description": "the ending IP for the Pod",
- "name": "endip",
+ "description": "indicates Vlan ID for the range",
+ "name": "vlanid",
"type": "list"
},
{
- "description": "indicates if range is dedicated for CPVM and SSVM",
- "name": "forsystemvms",
- "type": "list"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{
- "description": "the allocation state of the Pod",
- "name": "allocationstate",
+ "description": "the Zone ID of the Pod",
+ "name": "zoneid",
"type": "string"
},
{
+ "description": "indicates if range is dedicated for CPVM and SSVM",
+ "name": "forsystemvms",
+ "type": "list"
+ },
+ {
"description": "the name of the Pod",
"name": "name",
"type": "string"
},
- {},
{
- "description": "the gateway of the Pod",
- "name": "gateway",
+ "description": "the starting IP for the Pod",
+ "name": "startip",
+ "type": "list"
+ },
+ {
+ "description": "the ID of the Pod",
+ "name": "id",
"type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -419,20 +419,6 @@
"name": "ldapCreateAccount",
"params": [
{
- "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": "short"
- },
- {
- "description": "Unique username.",
- "length": 255,
- "name": "username",
- "required": true,
- "type": "string"
- },
- {
"description": "details for account used to store specific parameters",
"length": 255,
"name": "accountdetails",
@@ -440,13 +426,6 @@
"type": "map"
},
{
- "description": "Account UUID, required for adding account from external provisioning system",
- "length": 255,
- "name": "accountid",
- "required": false,
- "type": "string"
- },
- {
"description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
"length": 255,
"name": "timezone",
@@ -454,17 +433,16 @@
"type": "string"
},
{
- "description": "Creates the user under the specified domain.",
+ "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": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "account",
"required": false,
- "type": "uuid"
+ "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": "Network domain for the account's networks",
"length": 255,
- "name": "account",
+ "name": "networkdomain",
"required": false,
"type": "string"
},
@@ -477,11 +455,19 @@
"type": "uuid"
},
{
- "description": "Network domain for the account's networks",
+ "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
"length": 255,
- "name": "networkdomain",
+ "name": "accounttype",
"required": false,
- "type": "string"
+ "type": "short"
+ },
+ {
+ "description": "Creates the user under the specified domain.",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
},
{
"description": "User UUID, required for adding account from external provisioning system",
@@ -489,39 +475,38 @@
"name": "userid",
"required": false,
"type": "string"
- }
- ],
- "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts",
- "response": [
- {
- "description": "the total memory (in MB) the account can own",
- "name": "memorylimit",
- "type": "string"
},
{
- "description": "the state of the account",
- "name": "state",
+ "description": "Account UUID, required for adding account from external provisioning system",
+ "length": 255,
+ "name": "accountid",
+ "required": false,
"type": "string"
},
{
- "description": "the total number of public ip addresses this account can acquire",
- "name": "iplimit",
+ "description": "Unique username.",
+ "length": 255,
+ "name": "username",
+ "required": true,
"type": "string"
- },
+ }
+ ],
+ "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts",
+ "response": [
{
- "description": "the total secondary storage space (in GiB) the account can own",
- "name": "secondarystoragelimit",
- "type": "string"
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
},
{
- "description": "the total volume available for this account",
- "name": "volumeavailable",
- "type": "string"
+ "description": "the total volume being used by this account",
+ "name": "volumetotal",
+ "type": "long"
},
{
- "description": "the total number of vpcs owned by account",
- "name": "vpctotal",
- "type": "long"
+ "description": "the total number of projects the account can own",
+ "name": "projectlimit",
+ "type": "string"
},
{
"description": "name of the Domain the account belongs to",
@@ -529,78 +514,54 @@
"type": "string"
},
{
- "description": "the total number of virtual machines deployed by this account",
- "name": "vmtotal",
- "type": "long"
+ "description": "the total number of virtual machines running for this account",
+ "name": "vmrunning",
+ "type": "integer"
},
{
- "description": "the total number of snapshots stored by this account",
- "name": "snapshottotal",
+ "description": "the total number of virtual machines deployed by this account",
+ "name": "vmtotal",
"type": "long"
},
{
- "description": "id of the Domain the account belongs to",
- "name": "domainid",
- "type": "string"
- },
- {
"description": "the network domain",
"name": "networkdomain",
"type": "string"
},
+ {},
{
- "description": "the total number of cpu cores available to be created for this account",
- "name": "cpuavailable",
- "type": "string"
- },
- {
- "description": "the total number of projects available for administration by this account",
- "name": "projectavailable",
- "type": "string"
- },
- {
- "description": "the total number of cpu cores the account can own",
- "name": "cpulimit",
- "type": "string"
- },
- {
- "description": "the total number of projects the account can own",
- "name": "projectlimit",
+ "description": "the total primary storage space (in GiB) available to be used for this account",
+ "name": "primarystorageavailable",
"type": "string"
},
{
- "description": "the total number of vpcs available to be created for this account",
- "name": "vpcavailable",
- "type": "string"
+ "description": "the total number of public ip addresses allocated for this account",
+ "name": "iptotal",
+ "type": "long"
},
{
- "description": "the total number of snapshots available for this account",
- "name": "snapshotavailable",
- "type": "string"
+ "description": "the list of acl groups that account belongs to",
+ "name": "groups",
+ "type": "list"
},
{
- "description": "the total number of networks available to be created for this account",
- "name": "networkavailable",
+ "description": "the total number of templates which can be created by this account",
+ "name": "templatelimit",
"type": "string"
},
{
- "description": "the ID of the role",
- "name": "roleid",
+ "description": "the total number of cpu cores available to be created for this account",
+ "name": "cpuavailable",
"type": "string"
},
{
- "description": "true if account is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "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 secondary storage space (in GiB) available to be used for this account",
- "name": "secondarystorageavailable",
+ "description": "the id of the account",
+ "name": "id",
"type": "string"
},
{
@@ -609,34 +570,18 @@
"type": "long"
},
{
- "description": "the id of the account",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the total number of virtual machines that can be deployed by this account",
- "name": "vmlimit",
+ "description": "the total number of projects available for administration by this account",
+ "name": "projectavailable",
"type": "string"
},
{
- "description": "the total primary storage space (in GiB) the account can own",
- "name": "primarystoragelimit",
+ "description": "path of the Domain the account belongs to",
+ "name": "domainpath",
"type": "string"
},
- {},
- {
- "description": "the total number of virtual machines running for this account",
- "name": "vmrunning",
- "type": "integer"
- },
- {
- "description": "the total number of networks owned by account",
- "name": "networktotal",
- "type": "long"
- },
{
- "description": "the total primary storage space (in GiB) available to be used for this account",
- "name": "primarystorageavailable",
+ "description": "the total number of public ip addresses available for this account to acquire",
+ "name": "ipavailable",
"type": "string"
},
{
@@ -645,124 +590,8 @@
"type": "integer"
},
{
- "description": "the total number of cpu cores owned by account",
- "name": "cputotal",
- "type": "long"
- },
- {
- "description": "the total number of virtual machines available for this account to acquire",
- "name": "vmavailable",
- "type": "string"
- },
- {
- "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",
- "type": "string"
- },
- {},
- {
- "description": "the total volume which can be used by this account",
- "name": "volumelimit",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes received",
- "name": "receivedbytes",
- "type": "long"
- },
- {
- "description": "details for the account",
- "name": "accountdetails",
- "type": "map"
- },
- {
- "description": "the total primary storage space (in GiB) owned by account",
- "name": "primarystoragetotal",
- "type": "long"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the total number of projects being administrated by this account",
- "name": "projecttotal",
- "type": "long"
- },
- {
- "description": "the list of acl groups that account belongs to",
- "name": "groups",
- "type": "list"
- },
- {
- "description": "the total number of templates which can be created by this account",
- "name": "templatelimit",
- "type": "string"
- },
- {
- "description": "the total number of templates available to be created by this account",
- "name": "templateavailable",
- "type": "string"
- },
- {
- "description": "the total number of vpcs the account can own",
- "name": "vpclimit",
- "type": "string"
- },
- {
- "description": "the total number of network traffic bytes sent",
- "name": "sentbytes",
- "type": "long"
- },
- {
- "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
- "name": "roletype",
- "type": "string"
- },
- {
- "description": "the total number of networks the account can own",
- "name": "networklimit",
- "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) owned by account",
- "name": "secondarystoragetotal",
- "type": "float"
- },
- {
- "description": "the total number of public ip addresses allocated for this account",
- "name": "iptotal",
- "type": "long"
- },
- {
- "description": "the total memory (in MB) owned by account",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the total volume being used by this account",
- "name": "volumetotal",
- "type": "long"
- },
- {
- "description": "path of the Domain the account belongs to",
- "name": "domainpath",
- "type": "string"
- },
- {
- "description": "the total memory (in MB) available to be created for this account",
- "name": "memoryavailable",
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
"type": "string"
},
{
@@ -770,28 +599,33 @@
"name": "user",
"response": [
{
- "description": "the domain ID of the user",
- "name": "domainid",
+ "description": "the date and time the user account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the source type of the user in lowercase, such as native, ldap, saml2",
+ "name": "usersource",
"type": "string"
},
{
- "description": "the user email address",
- "name": "email",
+ "description": "the secret key of the user",
+ "name": "secretkey",
"type": "string"
},
{
- "description": "true if user is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "short"
},
{
- "description": "the api key of the user",
- "name": "apikey",
+ "description": "the user state",
+ "name": "state",
"type": "string"
},
{
- "description": "the user ID",
- "name": "id",
+ "description": "the domain name of the user",
+ "name": "domain",
"type": "string"
},
{
@@ -800,18 +634,18 @@
"type": "string"
},
{
- "description": "the secret key of the user",
- "name": "secretkey",
+ "description": "the api key of the user",
+ "name": "apikey",
"type": "string"
},
{
- "description": "the domain name of the user",
- "name": "domain",
+ "description": "the user ID",
+ "name": "id",
"type": "string"
},
{
- "description": "the user lastname",
- "name": "lastname",
+ "description": "the account name of the user",
+ "name": "account",
"type": "string"
},
{
@@ -820,82 +654,248 @@
"type": "string"
},
{
- "description": "the account ID of the user",
- "name": "accountid",
+ "description": "the timezone user was created in",
+ "name": "timezone",
"type": "string"
},
{
- "description": "the ID of the role",
- "name": "roleid",
+ "description": "the user email address",
+ "name": "email",
"type": "string"
},
{
- "description": "the date and time the user account was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the account name of the user",
- "name": "account",
+ "description": "the domain ID of the user",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the boolean value representing if the updating target is in caller's child domain",
- "name": "iscallerchilddomain",
- "type": "boolean"
+ "description": "the user lastname",
+ "name": "lastname",
+ "type": "string"
},
{
- "description": "the user firstname",
- "name": "firstname",
+ "description": "the name of the role",
+ "name": "rolename",
"type": "string"
},
{
- "description": "the user state",
- "name": "state",
- "type": "string"
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
},
{
- "description": "the timezone user was created in",
- "name": "timezone",
+ "description": "the ID of the role",
+ "name": "roleid",
"type": "string"
},
{
- "description": "the account type of the user",
- "name": "accounttype",
- "type": "short"
+ "description": "the user firstname",
+ "name": "firstname",
+ "type": "string"
},
{
- "description": "the name of the role",
- "name": "rolename",
+ "description": "the account ID of the user",
+ "name": "accountid",
"type": "string"
},
{
- "description": "the source type of the user in lowercase, such as native, ldap, saml2",
- "name": "usersource",
- "type": "string"
+ "description": "the boolean value representing if the updating target is in caller's child domain",
+ "name": "iscallerchilddomain",
+ "type": "boolean"
}
],
"type": "list"
},
{
- "description": "the total number of snapshots which can be stored by this account",
- "name": "snapshotlimit",
+ "description": "the total number of networks the account can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores the account can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects being administrated by this account",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of snapshots available for this account",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs the account can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) the account can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "id of the Domain the account belongs to",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the total volume which can be used by this account",
+ "name": "volumelimit",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of networks owned by account",
+ "name": "networktotal",
+ "type": "long"
+ },
+ {
+ "description": "the total memory (in MB) the account can own",
+ "name": "memorylimit",
"type": "string"
},
{
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "true if the account requires cleanup",
+ "name": "iscleanuprequired",
+ "type": "boolean"
+ },
+ {
"description": "account type (admin, domain-admin, user)",
"name": "accounttype",
"type": "short"
},
+ {},
+ {
+ "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by account",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this account",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) available to be created for this account",
+ "name": "memoryavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) owned by account",
+ "name": "primarystoragetotal",
+ "type": "long"
+ },
+ {
+ "description": "details for the account",
+ "name": "accountdetails",
+ "type": "map"
+ },
+ {
+ "description": "the state of the account",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates available to be created by this account",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs owned by account",
+ "name": "vpctotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of cpu cores owned by account",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) available to be used for this account",
+ "name": "secondarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks available to be created for this account",
+ "name": "networkavailable",
+ "type": "string"
+ },
{
"description": "the default zone of the account",
"name": "defaultzoneid",
"type": "string"
},
{
- "description": "true if the account requires cleanup",
- "name": "iscleanuprequired",
+ "description": "the total number of virtual machines available for this account to acquire",
+ "name": "vmavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) owned by account",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the name of the account",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "true if account is default, false otherwise",
+ "name": "isdefault",
"type": "boolean"
+ },
+ {
+ "description": "the total number of snapshots stored by this account",
+ "name": "snapshottotal",
+ "type": "long"
}
],
"since": "4.2.0"
@@ -919,6 +919,7 @@
"name": "success",
"type": "boolean"
},
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
@@ -930,7 +931,6 @@
"type": "string"
},
{},
- {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
@@ -945,14 +945,6 @@
"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",
- "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",
@@ -969,6 +961,14 @@
"type": "uuid"
},
{
+ "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",
+ "required": true,
+ "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",
@@ -980,68 +980,58 @@
"related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"response": [
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
- "type": "string"
- },
- {
- "description": "the name of the secondary storage host for the template",
- "name": "hostname",
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
"type": "string"
},
{
- "description": "the ID of the OS type for this template.",
- "name": "ostypeid",
+ "description": "the account name to which the template belongs",
+ "name": "account",
"type": "string"
},
{
- "description": "the project name of the template",
- "name": "project",
+ "description": "the type of the template",
+ "name": "templatetype",
"type": "string"
},
{
- "description": "true if this template is a featured template, false otherwise",
- "name": "isfeatured",
+ "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
+ "name": "directdownload",
"type": "boolean"
},
{
- "description": "the template name",
- "name": "name",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"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": "the tag of this template",
+ "name": "templatetag",
+ "type": "string"
},
{
- "description": "the format of the template.",
- "name": "format",
- "type": "imageformat"
+ "description": "the project name of the template",
+ "name": "project",
+ "type": "string"
},
{
- "description": "if root disk template, then ids of the datas disk templates this template owns",
- "name": "childtemplates",
- "type": "set"
+ "description": "additional key/value details tied with template",
+ "name": "details",
+ "type": "map"
},
{
- "description": "the name of the zone for this template",
- "name": "zonename",
- "type": "string"
+ "description": "true if the template is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
},
{
- "description": "if Datadisk template, then id of the root disk template this template belongs to",
- "name": "parenttemplateid",
+ "description": "the template ID",
+ "name": "id",
"type": "string"
},
{
- "description": "Lists the download progress of a template across all secondary storages",
- "name": "downloaddetails",
- "type": "list"
- },
- {
- "description": "the URL which the template/iso is registered from",
- "name": "url",
+ "description": "the ID of the zone for this template",
+ "name": "zoneid",
"type": "string"
},
{
@@ -1049,13 +1039,8 @@
"name": "tags",
"response": [
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
@@ -1064,13 +1049,13 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -1079,8 +1064,8 @@
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
@@ -1089,62 +1074,72 @@
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the template ID of the parent template if present",
- "name": "sourcetemplateid",
- "type": "string"
+ "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
},
{
- "description": "the tag of this template",
- "name": "templatetag",
+ "description": "checksum of the template",
+ "name": "checksum",
"type": "string"
},
{
- "description": "true if template requires HVM enabled, false otherwise",
- "name": "requireshvm",
+ "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": "the account id to which the template belongs",
- "name": "accountid",
+ "description": "the name of the zone for this template",
+ "name": "zonename",
"type": "string"
},
{
- "description": "additional key/value details tied with template",
- "name": "details",
- "type": "map"
- },
- {
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "the template ID",
- "name": "id",
- "type": "string"
+ "description": "the physical size of the template",
+ "name": "physicalsize",
+ "type": "long"
},
{
- "description": "true if this template is a public template, false otherwise",
- "name": "ispublic",
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the format of the template.",
+ "name": "format",
+ "type": "imageformat"
+ },
+ {
+ "description": "true if this template is a featured template, false otherwise",
+ "name": "isfeatured",
"type": "boolean"
},
{
- "description": "the ID of the zone for this template",
- "name": "zoneid",
- "type": "string"
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
},
{
"description": "the name of the domain to which the template belongs",
@@ -1152,55 +1147,59 @@
"type": "string"
},
{
- "description": "the ID of the domain to which the template belongs",
- "name": "domainid",
+ "description": "the account id to which the template belongs",
+ "name": "accountid",
"type": "string"
},
{
- "description": "the processor bit size",
- "name": "bits",
- "type": "int"
+ "description": "if root disk template, then ids of the datas disk templates this template owns",
+ "name": "childtemplates",
+ "type": "set"
},
- {},
{
- "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
- "name": "directdownload",
- "type": "boolean"
+ "description": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
},
{
- "description": "the project id of the template",
- "name": "projectid",
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
"type": "string"
},
- {},
{
- "description": "the physical size of the template",
- "name": "physicalsize",
- "type": "long"
+ "description": "the name of the secondary storage host for the template",
+ "name": "hostname",
+ "type": "string"
},
{
- "description": "true if the ISO is bootable, false otherwise",
- "name": "bootable",
+ "description": "true if template requires HVM enabled, false otherwise",
+ "name": "requireshvm",
"type": "boolean"
},
{
- "description": "checksum of the template",
- "name": "checksum",
+ "description": "the template display text",
+ "name": "displaytext",
"type": "string"
},
{
- "description": "the type of the template",
- "name": "templatetype",
+ "description": "if Datadisk template, then id of the root disk template this template belongs to",
+ "name": "parenttemplateid",
"type": "string"
},
+ {},
{
- "description": "true if the template is extractable, false otherwise",
- "name": "isextractable",
+ "description": "true if the template is managed across all Zones, false otherwise",
+ "name": "crossZones",
"type": "boolean"
},
{
- "description": "the ID of the secondary storage host for the template",
- "name": "hostid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the URL which the template/iso is registered from",
+ "name": "url",
"type": "string"
},
{
@@ -1209,69 +1208,70 @@
"type": "long"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the ID of the secondary storage host for the template",
+ "name": "hostid",
"type": "string"
},
{
- "description": "the date this template was removed",
- "name": "removed",
- "type": "date"
- },
- {
- "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
- "name": "isdynamicallyscalable",
+ "description": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
"type": "boolean"
},
+ {},
{
"description": "true if template is sshkey enabled, false otherwise",
"name": "sshkeyenabled",
"type": "boolean"
},
{
- "description": "the status of the template",
- "name": "status",
- "type": "string"
+ "description": "the processor bit size",
+ "name": "bits",
+ "type": "int"
},
{
- "description": "true if the template is managed across all Zones, false otherwise",
- "name": "crossZones",
+ "description": "true if the template is ready to be deployed from, false otherwise.",
+ "name": "isready",
"type": "boolean"
},
{
- "description": "the template display text",
- "name": "displaytext",
- "type": "string"
+ "description": "true if the reset password feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
},
{
- "description": "the account name to which the template belongs",
- "name": "account",
+ "description": "VMware only: additional key/value details tied with deploy-as-is template",
+ "name": "deployasisdetails",
+ "type": "map"
+ },
+ {
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
"type": "string"
},
{
- "description": "the name of the OS type for this template.",
- "name": "ostypename",
+ "description": "the project id of the template",
+ "name": "projectid",
"type": "string"
},
{
- "description": "true if the reset password feature is enabled, false otherwise",
- "name": "passwordenabled",
+ "description": "true if the ISO is bootable, false otherwise",
+ "name": "bootable",
"type": "boolean"
},
{
- "description": "VMware only: additional key/value details tied with deploy-as-is template",
- "name": "deployasisdetails",
- "type": "map"
+ "description": "the template ID of the parent template if present",
+ "name": "sourcetemplateid",
+ "type": "string"
},
{
- "description": "the date this template was created",
- "name": "created",
- "type": "date"
+ "description": "the template name",
+ "name": "name",
+ "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"
}
]
},
@@ -1281,10 +1281,17 @@
"name": "provisionCertificate",
"params": [
{
+ "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used",
+ "length": 255,
+ "name": "provider",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)",
"length": 255,
"name": "hostid",
- "related": "addBaremetalHost,addHost,cancelHostMaintenance,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,listExternalLoadBalancers",
+ "related": "addHost,cancelHostMaintenance,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
"required": true,
"type": "uuid"
},
@@ -1294,16 +1301,14 @@
"name": "reconnect",
"required": false,
"type": "boolean"
- },
- {
- "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used",
- "length": 255,
- "name": "provider",
- "required": false,
- "type": "string"
}
],
"response": [
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
{},
{},
{
@@ -1312,11 +1317,6 @@
"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"
@@ -1344,24 +1344,24 @@
}
],
"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",
"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",
+ "type": "integer"
+ },
+ {},
+ {
"description": "any text associated with the success or failure",
"name": "displaytext",
"type": "string"
@@ -1374,6 +1374,13 @@
"name": "addExternalFirewall",
"params": [
{
+ "description": "URL of the external firewall appliance.",
+ "length": 255,
+ "name": "url",
+ "required": true,
+ "type": "string"
+ },
+ {
"description": "Zone in which to add the external firewall appliance.",
"length": 255,
"name": "zoneid",
@@ -1389,13 +1396,6 @@
"type": "string"
},
{
- "description": "URL of the external firewall appliance.",
- "length": 255,
- "name": "url",
- "required": true,
- "type": "string"
- },
- {
"description": "Username of the external firewall appliance.",
"length": 255,
"name": "username",
@@ -1406,75 +1406,75 @@
"related": "listExternalFirewalls",
"response": [
{
- "description": "the public interface of the external firewall",
- "name": "publicinterface",
+ "description": "the username that's used to log in to the external firewall",
+ "name": "username",
"type": "string"
},
{
- "description": "the zone ID of the external firewall",
- "name": "zoneid",
+ "description": "the public security zone of the external firewall",
+ "name": "publiczone",
"type": "string"
},
{
- "description": "the timeout (in seconds) for requests to the external firewall",
- "name": "timeout",
+ "description": "the zone ID of the external firewall",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the ID of the network device",
- "name": "id",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the usage interface of the external firewall",
- "name": "usageinterface",
+ "description": "the private interface of the external firewall",
+ "name": "privateinterface",
"type": "string"
},
+ {},
+ {},
{
- "description": "the number of times to retry requests to the external firewall",
- "name": "numretries",
+ "description": "the ID of the external firewall",
+ "name": "id",
"type": "string"
},
{
- "description": "the public security zone of the external firewall",
- "name": "publiczone",
+ "description": "the management IP address of the external firewall",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "the private interface of the external firewall",
- "name": "privateinterface",
+ "description": "the public interface of the external firewall",
+ "name": "publicinterface",
"type": "string"
},
- {},
{
- "description": "the username that's used to log in to the external firewall",
- "name": "username",
+ "description": "the timeout (in seconds) for requests to the external firewall",
+ "name": "timeout",
"type": "string"
},
{
- "description": "the ID of the external firewall",
- "name": "id",
+ "description": "the usage interface of the external firewall",
+ "name": "usageinterface",
"type": "string"
},
- {},
{
"description": "the private security zone of the external firewall",
"name": "privatezone",
"type": "string"
},
{
+ "description": "the ID of the network device",
+ "name": "id",
+ "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",
- "type": "string"
- },
- {
- "description": "the management IP address of the external firewall",
- "name": "ipaddress",
+ "description": "the number of times to retry requests to the external firewall",
+ "name": "numretries",
"type": "string"
}
]
@@ -1488,34 +1488,34 @@
"description": "Id of the external loadbalancer appliance.",
"length": 255,
"name": "id",
- "related": "addBaremetalHost,addHost,cancelHostMaintenance,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,listExternalLoadBalancers",
+ "related": "addHost,cancelHostMaintenance,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
"required": true,
"type": "uuid"
}
],
"response": [
{
- "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",
- "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"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ }
]
},
{
@@ -1524,9 +1524,17 @@
"name": "listVirtualMachinesMetrics",
"params": [
{
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
@@ -1539,18 +1547,9 @@
"type": "uuid"
},
{
- "description": "list by network id",
- "length": 255,
- "name": "networkid",
- "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "the storage ID where vm's volumes belong to",
+ "description": "list vms by iso",
"length": 255,
- "name": "storageid",
- "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool",
+ "name": "isoid",
"required": false,
"type": "uuid"
},
@@ -1562,10 +1561,10 @@
"type": "string"
},
{
- "description": "the availability zone ID",
+ "description": "list vms by affinity group",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "affinitygroupid",
+ "related": "createAffinityGroup,listAffinityGroups",
"required": false,
"type": "uuid"
},
@@ -1577,51 +1576,50 @@
"type": "boolean"
},
{
- "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled",
+ "description": "list vms by ssh keypair name",
"length": 255,
- "name": "haenable",
+ "name": "keypair",
"required": false,
- "since": "4.15",
- "type": "boolean"
+ "type": "string"
},
{
- "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "description": "the user ID that created the VM and is under the account that owns the VM",
"length": 255,
- "name": "displayvm",
+ "name": "userid",
+ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
"required": false,
- "since": "4.4",
- "type": "boolean"
+ "type": "uuid"
},
{
- "description": "list vms by iso",
+ "description": "List resources by tags (key/value pairs)",
"length": 255,
- "name": "isoid",
+ "name": "tags",
"required": false,
- "type": "uuid"
+ "type": "map"
},
{
- "description": "",
+ "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": "pagesize",
+ "name": "details",
"required": false,
- "type": "integer"
+ "type": "list"
},
{
- "description": "list vms by vpc",
+ "description": "list by the service offering",
"length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,restartVPC,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
+ "name": "serviceofferingid",
+ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
"required": false,
+ "since": "4.4",
"type": "uuid"
},
{
- "description": "the IDs of the virtual machines, mutually exclusive with id",
+ "description": "the storage ID where vm's volumes belong to",
"length": 255,
- "name": "ids",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMS [...]
+ "name": "storageid",
+ "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool",
"required": false,
- "since": "4.4",
- "type": "list"
+ "type": "uuid"
},
{
"description": "the target hypervisor for the template",
@@ -1631,64 +1629,59 @@
"type": "string"
},
{
- "description": "List resources by tags (key/value pairs)",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
- "description": "list resources by account. Must be used with the domainId parameter.",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "account",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "List by keyword",
+ "description": "the security group ID",
"length": 255,
- "name": "keyword",
+ "name": "securitygroupid",
+ "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup",
"required": false,
- "type": "string"
+ "since": "4.15",
+ "type": "uuid"
},
{
- "description": "list vms by affinity group",
+ "description": "the availability zone ID",
"length": 255,
- "name": "affinitygroupid",
- "related": "createAffinityGroup,listAffinityGroups",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
"type": "uuid"
},
{
- "description": "list vms by template",
+ "description": "list by network id",
"length": 255,
- "name": "templateid",
- "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "name": "networkid",
+ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
"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": "list by network type; true if need to list vms using Virtual Network, false otherwise",
"length": 255,
- "name": "details",
+ "name": "forvirtualnetwork",
"required": false,
- "type": "list"
+ "type": "boolean"
},
{
- "description": "list objects by project",
+ "description": "the host ID",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
"required": false,
"type": "uuid"
},
{
- "description": "the host ID",
+ "description": "List by keyword",
"length": 255,
- "name": "hostid",
- "related": "addBaremetalHost,addHost,cancelHostMaintenance,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,listExternalLoadBalancers",
+ "name": "keyword",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "the ID of the virtual machine",
@@ -1699,14 +1692,21 @@
"type": "uuid"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "list vms by template",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "templateid",
+ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
"required": false,
"type": "uuid"
},
{
+ "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": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "the pod ID",
"length": 255,
"name": "podid",
@@ -1715,84 +1715,104 @@
"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",
+ "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled",
"length": 255,
- "name": "listall",
+ "name": "haenable",
"required": false,
+ "since": "4.15",
"type": "boolean"
},
{
- "description": "list by network type; true if need to list vms using Virtual Network, false otherwise",
+ "description": "",
"length": 255,
- "name": "forvirtualnetwork",
+ "name": "page",
"required": false,
- "type": "boolean"
+ "type": "integer"
},
{
- "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)",
+ "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",
"length": 255,
- "name": "name",
+ "name": "listall",
"required": false,
- "type": "string"
+ "type": "boolean"
},
{
- "description": "the user ID that created the VM and is under the account that owns the VM",
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
"length": 255,
- "name": "userid",
- "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
+ "name": "displayvm",
"required": false,
- "type": "uuid"
+ "since": "4.4",
+ "type": "boolean"
},
{
- "description": "list vms by ssh keypair name",
+ "description": "the IDs of the virtual machines, mutually exclusive with id",
"length": 255,
- "name": "keypair",
+ "name": "ids",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMS [...]
"required": false,
- "type": "string"
+ "since": "4.4",
+ "type": "list"
},
{
- "description": "the security group ID",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "securitygroupid",
- "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup",
+ "name": "account",
"required": false,
- "since": "4.15",
- "type": "uuid"
+ "type": "string"
},
{
- "description": "list by the service offering",
+ "description": "list vms by vpc",
"length": 255,
- "name": "serviceofferingid",
- "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,restartVPC,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
"required": false,
- "since": "4.4",
"type": "uuid"
}
],
"related": "",
"response": [
{
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
"description": "list of security groups associated with the virtual machine",
"name": "securitygroup",
"response": [
{
- "description": "the ID of the security group",
- "name": "id",
+ "description": "the domain name of the security group",
+ "name": "domain",
"type": "string"
},
{
- "description": "the name of the security group",
- "name": "name",
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
},
{
- "description": "the domain name of the security group",
- "name": "domain",
+ "description": "the description of the security group",
+ "name": "description",
"type": "string"
},
{
@@ -1800,33 +1820,33 @@
"name": "tags",
"response": [
{
- "description": "tag value",
- "name": "value",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
@@ -1835,34 +1855,24 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "tag value",
+ "name": "value",
"type": "string"
}
],
"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 domain ID of the security group",
"name": "domainid",
"type": "string"
@@ -1872,50 +1882,40 @@
"name": "egressrule",
"response": [
{
- "description": "the id of the security group rule",
- "name": "ruleid",
- "type": "string"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
"type": "integer"
},
{
- "description": "account owning the security group rule",
- "name": "account",
+ "description": "security group name",
+ "name": "securitygroupname",
"type": "string"
},
{
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
"description": "the protocol of the security group rule",
"name": "protocol",
"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"
},
{
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
{
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
"description": "id of the resource",
"name": "resourceid",
"type": "string"
@@ -1926,13 +1926,13 @@
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
@@ -1941,61 +1941,71 @@
"type": "string"
},
{
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
"description": "the project name where tag belongs to",
"name": "project",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
}
],
"type": "set"
},
{
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
},
{
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
"type": "integer"
},
{
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
}
],
"type": "set"
},
{
- "description": "the project name of the group",
- "name": "project",
+ "description": "the name of the security group",
+ "name": "name",
"type": "string"
},
{
- "description": "the project id of the group",
- "name": "projectid",
+ "description": "the account owning the security group",
+ "name": "account",
"type": "string"
},
{
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
"description": "the list of ingress rules associated with the security group",
"name": "ingressrule",
"response": [
{
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "the list of resource tags associated with the rule",
"name": "tags",
"response": [
@@ -2005,18 +2015,18 @@
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -2025,28 +2035,28 @@
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
}
],
@@ -2063,13 +2073,13 @@
"type": "integer"
},
{
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
},
{
- "description": "account owning the security group rule",
- "name": "account",
+ "description": "security group name",
+ "name": "securitygroupname",
"type": "string"
},
{
@@ -2078,16 +2088,6 @@
"type": "string"
},
{
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
"description": "the protocol of the security group rule",
"name": "protocol",
"type": "string"
@@ -2096,31 +2096,56 @@
"description": "the ending IP of the security group rule ",
"name": "endport",
"type": "integer"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
}
],
"type": "set"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
}
],
"type": "set"
},
{
- "description": "network read in MiB",
- "name": "networkread",
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
"type": "string"
},
{
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
"type": "string"
},
{
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
"type": "long"
},
{
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
"type": "string"
},
{
@@ -2129,8 +2154,13 @@
"type": "string"
},
{
- "description": "the name of the service offering of the virtual machine",
- "name": "serviceofferingname",
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
"type": "string"
},
{
@@ -2139,181 +2169,273 @@
"type": "string"
},
{
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
+ "description": "the total disk iops",
+ "name": "diskiopstotal",
"type": "long"
},
{
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
+ "description": "disk read in MiB",
+ "name": "diskread",
"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 vgpu type used by the virtual machine",
+ "name": "vgpu",
"type": "string"
},
{
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
+ "type": "long"
},
{
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
+ "description": "List of UI read-only Vm details as comma separated string.",
+ "name": "readonlyuidetails",
"type": "string"
},
+ {},
{
- "description": "the date when this virtual machine was created",
- "name": "created",
- "type": "date"
+ "description": "the write (bytes) of disk on the vm",
+ "name": "diskkbswrite",
+ "type": "long"
},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
"type": "string"
},
{
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
- "type": "string"
+ "description": "the speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
},
+ {},
{
- "description": "the read (bytes) of disk on the vm",
- "name": "diskkbsread",
+ "description": "the internal memory that's free in vm or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
"type": "long"
},
{
- "description": "device type of the root volume",
- "name": "rootdevicetype",
- "type": "string"
- },
- {
- "description": "the state of the virtual machine",
- "name": "state",
+ "description": "the VM's primary IP address",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "the memory allocated for the virtual machine",
- "name": "memory",
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
"type": "integer"
},
{
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
"type": "string"
},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
+ "description": "disk write in MiB",
+ "name": "diskwrite",
"type": "string"
},
{
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
- "description": "List of UI read-only Vm details as comma separated string.",
- "name": "readonlyuidetails",
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
"type": "string"
},
{
- "description": "the read (io) of disk on the vm",
- "name": "diskioread",
- "type": "long"
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
},
{
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
"type": "string"
},
{
- "description": "network write in MiB",
- "name": "networkwrite",
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
"type": "string"
},
{
- "description": "list of affinity groups associated with the virtual machine",
- "name": "affinitygroup",
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
"response": [
{
- "description": "the project name of the affinity group",
- "name": "project",
+ "description": "the gateway of the nic",
+ "name": "gateway",
"type": "string"
},
{
- "description": "the domain ID of the affinity group",
- "name": "domainid",
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
"type": "string"
},
{
- "description": "the type of the affinity group",
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
"name": "type",
"type": "string"
},
{
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
"type": "list"
},
{
- "description": "the ID of the affinity group",
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
"name": "id",
"type": "string"
},
{
- "description": "the project ID of the affinity group",
- "name": "projectid",
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
"type": "string"
},
{
- "description": "the description of the affinity group",
- "name": "description",
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
"type": "string"
},
{
- "description": "the account owning the affinity group",
- "name": "account",
+ "description": "the netmask of the nic",
+ "name": "netmask",
"type": "string"
},
{
- "description": "the name of the affinity group",
- "name": "name",
+ "description": "the name of the corresponding network",
+ "name": "networkname",
"type": "string"
},
{
- "description": "the domain name of the affinity group",
- "name": "domain",
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "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": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
+ "description": "the total cpu capacity in Ghz",
+ "name": "cputotal",
"type": "string"
},
{
- "description": "the total disk iops",
- "name": "diskiopstotal",
- "type": "long"
- },
- {
- "description": "the name of the host for the virtual machine",
- "name": "hostname",
+ "description": "the project name of the vm",
+ "name": "project",
"type": "string"
},
{
- "description": "disk read in MiB",
- "name": "diskread",
- "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 group name of the virtual machine",
@@ -2321,23 +2443,18 @@
"type": "string"
},
{
- "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
- "name": "displayname",
- "type": "string"
- },
- {
- "description": "the project id of the vm",
- "name": "projectid",
+ "description": "the name of the virtual machine",
+ "name": "name",
"type": "string"
},
{
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
+ "description": "ssh key-pair",
+ "name": "keypair",
"type": "string"
},
{
- "description": "the group ID of the virtual machine",
- "name": "groupid",
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
"type": "string"
},
{
@@ -2345,13 +2462,13 @@
"name": "tags",
"response": [
{
- "description": "tag value",
- "name": "value",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
@@ -2360,13 +2477,13 @@
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
@@ -2375,296 +2492,220 @@
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
"description": "public IP address id associated with vm via Static nat rule",
"name": "publicipid",
"type": "string"
},
{
- "description": "the account associated with the virtual machine",
- "name": "account",
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
"type": "string"
},
{
- "description": "the name of the template for the virtual machine",
- "name": "templatename",
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
"type": "string"
},
+ {},
{
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the ID of the availablility zone for the virtual machine",
- "name": "zoneid",
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
"type": "string"
},
{
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
+ "description": "network read in MiB",
+ "name": "networkread",
+ "type": "string"
},
{
- "description": "the ID of the backup offering of the virtual machine",
- "name": "backupofferingid",
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
"type": "string"
},
- {},
{
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
"type": "string"
},
- {},
{
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
},
{
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
"type": "long"
},
{
- "description": "Guest vm Boot Type",
- "name": "boottype",
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
"type": "string"
},
{
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
+ "description": "the ID of the virtual machine",
+ "name": "id",
"type": "string"
},
{
- "description": "the project name of the vm",
- "name": "project",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the ID of the ISO attached to the virtual machine",
- "name": "isoid",
- "type": "string"
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
},
{
- "description": "the ID of the virtual machine",
- "name": "id",
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
"type": "string"
},
{
- "description": "ssh key-pair",
- "name": "keypair",
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
"type": "string"
},
{
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
+ "description": "network write in MiB",
+ "name": "networkwrite",
+ "type": "string"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
"type": "string"
},
{
- "description": "the memory used by the vm",
- "name": "memorykbs",
- "type": "long"
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
},
{
- "description": "State of the Service from LB rule",
- "name": "servicestate",
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
"type": "string"
},
{
- "description": "the list of nics associated with vm",
- "name": "nic",
+ "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": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
"response": [
{
- "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
- "name": "nsxlogicalswitch",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "macaddress",
- "type": "string"
- },
- {
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the type of the nic",
- "name": "type",
- "type": "string"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "the ID of the nic",
+ "description": "the ID of the affinity group",
"name": "id",
"type": "string"
},
{
- "description": "the gateway of the nic",
- "name": "gateway",
- "type": "string"
- },
- {
- "description": "the netmask of the nic",
- "name": "netmask",
- "type": "string"
- },
- {
- "description": "the isolation uri of the nic",
- "name": "isolationuri",
- "type": "string"
- },
- {
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
- "type": "string"
- },
- {
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
- "type": "string"
- },
- {
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
- },
- {
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
+ "description": "the type of the affinity group",
+ "name": "type",
"type": "string"
},
{
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
+ "description": "the project name of the affinity group",
+ "name": "project",
"type": "string"
},
{
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
- },
- {
- "description": "the name of the corresponding network",
- "name": "networkname",
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
+ "description": "the description of the affinity group",
+ "name": "description",
"type": "string"
},
{
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "Type of adapter if available",
- "name": "adaptertype",
+ "description": "the name of the affinity group",
+ "name": "name",
"type": "string"
},
{
- "description": "the ID of the corresponding network",
- "name": "networkid",
+ "description": "the domain name of the affinity group",
+ "name": "domain",
"type": "string"
},
{
- "description": "the Secondary ipv4 addr of nic",
- "name": "secondaryip",
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
"type": "list"
},
{
- "description": "the ip address of the nic",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
- },
- {
- "description": "the IPv6 address of network",
- "name": "ip6address",
+ "description": "the account owning the affinity group",
+ "name": "account",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the vgpu type used by the virtual machine",
- "name": "vgpu",
+ "description": "the account associated with the virtual machine",
+ "name": "account",
"type": "string"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
"type": "long"
},
{
- "description": "the name of the availability zone for the virtual machine",
- "name": "zonename",
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
"type": "string"
},
{
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
},
{
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
},
{
"description": "the target memory in vm",
@@ -2672,60 +2713,19 @@
"type": "long"
},
{
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {},
- {
- "description": "the name of the virtual machine",
- "name": "name",
- "type": "string"
- },
- {
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
- "type": "string"
- },
- {
- "description": "the total cpu capacity in Ghz",
- "name": "cputotal",
- "type": "string"
- },
- {
- "description": " an alternate display text of the template for the virtual machine",
- "name": "templatedisplaytext",
- "type": "string"
- },
- {
- "description": "disk write in MiB",
- "name": "diskwrite",
- "type": "string"
- },
- {
- "description": "the VM's primary IP address",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
- "type": "string"
- },
- {
"description": "an optional field whether to the display the vm to the end user or not.",
"name": "displayvm",
"type": "boolean"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
"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 incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
},
{
"description": "the name of the domain in which the virtual machine exists",
@@ -2741,49 +2741,28 @@
"name": "listHosts",
"params": [
{
- "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]",
+ "description": "list hosts for which out-of-band management is enabled",
"length": 255,
- "name": "outofbandmanagementpowerstate",
+ "name": "outofbandmanagementenabled",
"required": false,
- "type": "string"
+ "type": "boolean"
},
{
- "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": "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"
},
{
- "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": "if true, list only hosts dedicated to HA",
- "length": 255,
- "name": "hahost",
- "required": false,
- "type": "boolean"
- },
- {
- "description": "",
- "length": 255,
- "name": "page",
- "required": false,
- "type": "integer"
- },
- {
"description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM",
"length": 255,
"name": "virtualmachineid",
@@ -2799,27 +2778,26 @@
"type": "string"
},
{
- "description": "the Zone ID for the host",
+ "description": "the state of the host",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "state",
"required": false,
- "type": "uuid"
+ "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 name of the host",
+ "description": "the Zone ID for the host",
"length": 255,
- "name": "name",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "List by keyword",
@@ -2829,16 +2807,17 @@
"type": "string"
},
{
- "description": "the state of the host",
+ "description": "the Pod ID for the host",
"length": 255,
- "name": "state",
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "list hosts for which out-of-band management is enabled",
+ "description": "if true, list only hosts dedicated to HA",
"length": 255,
- "name": "outofbandmanagementenabled",
+ "name": "hahost",
"required": false,
"type": "boolean"
},
@@ -2846,11 +2825,18 @@
"description": "the id of the host",
"length": 255,
"name": "id",
- "related": "addBaremetalHost,addHost,cancelHostMaintenance,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,listExternalLoadBalancers",
+ "related": "addHost,cancelHostMaintenance,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
"required": false,
"type": "uuid"
},
{
+ "description": "the host type",
+ "length": 255,
+ "name": "type",
+ "required": false,
+ "type": "string"
+ },
+ {
"description": "",
"length": 255,
"name": "pagesize",
@@ -2858,44 +2844,33 @@
"type": "integer"
},
{
- "description": "the host type",
+ "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": "type",
+ "name": "resourcestate",
"required": false,
"type": "string"
- }
- ],
- "related": "addBaremetalHost,addHost,cancelHostMaintenance,prepareHostForMaintenance,reconnectHost,updateHost,listExternalLoadBalancers",
- "response": [
- {
- "description": "the IP address of the host",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
- "type": "boolean"
- },
- {
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
- "type": "long"
},
{
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
- "type": "long"
+ "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": "events available for the host",
- "name": "events",
+ "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": "outofbandmanagementpowerstate",
+ "required": false,
"type": "string"
- },
+ }
+ ],
+ "related": "addHost,cancelHostMaintenance,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
+ "response": [
{
- "description": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
},
{
"description": "capabilities of the host",
@@ -2903,14 +2878,14 @@
"type": "string"
},
{
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
"type": "string"
},
{
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
},
{
"description": "the OS category ID of the host",
@@ -2918,24 +2893,24 @@
"type": "string"
},
{
- "description": "the cluster ID of the host",
- "name": "clusterid",
- "type": "string"
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
},
{
- "description": "the host HA information information",
- "name": "hostha",
- "type": "hostharesponse"
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
},
{
- "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 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 time this host was annotated",
@@ -2943,46 +2918,122 @@
"type": "date"
},
{
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
"description": "Host details in key/value pairs.",
"name": "details",
"type": "map"
},
{
- "description": "GPU cards present in the host",
- "name": "gpugroup",
- "response": [
- {
- "description": "GPU cards present in the host",
- "name": "gpugroupname",
- "type": "string"
- },
- {
- "description": "the list of enabled vGPUs",
- "name": "vgpu",
- "response": [
- {
- "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"
- },
- {
- "description": "Maximum X resolution per display",
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
+ },
+ {
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "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 host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "the last annotation set on this host by an admin",
+ "name": "annotation",
+ "type": "string"
+ },
+ {
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroup",
+ "response": [
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroupname",
+ "type": "string"
+ },
+ {
+ "description": "the list of enabled vGPUs",
+ "name": "vgpu",
+ "response": [
+ {
+ "description": "Maximum X resolution per display",
"name": "maxresolutionx",
"type": "long"
},
{
- "description": "Model Name of vGPU",
- "name": "vgputype",
- "type": "string"
- },
- {
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
+ "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type",
+ "name": "remainingcapacity",
"type": "long"
},
{
@@ -2991,14 +3042,29 @@
"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": "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",
+ "type": "long"
+ },
+ {
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
}
],
"type": "list"
@@ -3007,33 +3073,28 @@
"type": "list"
},
{
- "description": "the outgoing network traffic on the host",
- "name": "networkkbswrite",
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
"type": "long"
},
{
- "description": "the cluster name of the host",
- "name": "clustername",
+ "description": "the name of the host",
+ "name": "name",
"type": "string"
},
{
- "description": "the host type",
- "name": "type",
- "type": "type"
- },
- {
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
- "type": "boolean"
- },
- {
"description": "the amount of the host's CPU currently allocated in MHz",
"name": "cpuallocatedvalue",
"type": "long"
},
{
- "description": "the resource state of the host",
- "name": "resourcestate",
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "type": "string"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
"type": "string"
},
{
@@ -3042,50 +3103,54 @@
"type": "double"
},
{
- "description": "the amount of the host's memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
- "type": "long"
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
},
{
- "description": "the admin that annotated this host",
- "name": "username",
+ "description": "the Zone name of the host",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the OS category name of the host",
- "name": "oscategoryname",
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
"type": "string"
},
{
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
},
- {},
{
- "description": "the hypervisor version",
- "name": "hypervisorversion",
- "type": "string"
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
},
{
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
+ "description": "the resource state of the host",
+ "name": "resourcestate",
"type": "string"
},
{
- "description": "the date and time the host was removed",
- "name": "removed",
- "type": "date"
+ "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",
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
+ "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",
@@ -3093,13 +3158,8 @@
"type": "boolean"
},
{
- "description": "comma-separated list of tags for the host",
- "name": "hosttags",
- "type": "string"
- },
- {
- "description": "the amount of the host's CPU currently allocated in percentage",
- "name": "cpuallocatedpercentage",
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
"type": "string"
},
{
@@ -3108,19 +3168,19 @@
"type": "string"
},
{
- "description": "the name of the host",
- "name": "name",
- "type": "string"
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
},
{
- "description": "the management server ID of the host",
- "name": "managementserverid",
+ "description": "the Pod name of the host",
+ "name": "podname",
"type": "string"
},
{
- "description": "the state of the host",
- "name": "state",
- "type": "status"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
"description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
@@ -3128,101 +3188,41 @@
"type": "boolean"
},
{
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
- "type": "string"
- },
- {
"description": "the ID of the host",
"name": "id",
"type": "string"
},
{
- "description": "the CPU speed of the host",
- "name": "cpuspeed",
- "type": "long"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
- },
- {
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
- "type": "string"
- },
- {
- "description": "the last annotation set on this host by an admin",
- "name": "annotation",
- "type": "string"
- },
- {
"description": "true if the host is disconnected. False otherwise.",
"name": "disconnected",
"type": "date"
},
{
- "description": "the Pod name of the host",
- "name": "podname",
- "type": "string"
- },
- {
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "name": "memorywithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the host version",
- "name": "version",
- "type": "string"
- },
- {
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
},
{
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
- "type": "string"
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
},
{
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
+ "description": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
},
{
- "description": "the Zone ID of the host",
- "name": "zoneid",
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
"type": "string"
},
- {},
{
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
},
- {
- "description": "the Zone name of the host",
- "name": "zonename",
- "type": "string"
- }
+ {}
]
},
{
@@ -3248,27 +3248,27 @@
],
"response": [
{},
- {},
- {
- "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"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
"type": "string"
- }
+ },
+ {}
]
},
{
@@ -3277,26 +3277,27 @@
"name": "listVsphereStoragePolicyCompatiblePools",
"params": [
{
- "description": "ID of the zone",
+ "description": "",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "page",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
- "description": "",
+ "description": "ID of the storage policy",
"length": 255,
- "name": "page",
+ "name": "policyid",
+ "related": "importVsphereStoragePolicies,listVsphereStoragePolicies",
"required": false,
- "type": "integer"
+ "type": "uuid"
},
{
- "description": "",
+ "description": "ID of the zone",
"length": 255,
- "name": "pagesize",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
- "type": "integer"
+ "type": "uuid"
},
{
"description": "List by keyword",
@@ -3306,24 +3307,28 @@
"type": "string"
},
{
- "description": "ID of the storage policy",
+ "description": "",
"length": 255,
- "name": "policyid",
- "related": "importVsphereStoragePolicies,listVsphereStoragePolicies",
+ "name": "pagesize",
"required": false,
- "type": "uuid"
+ "type": "integer"
}
],
"related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool",
"response": [
{
- "description": "true if this pool is suitable to migrate a volume, false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
+ "description": "the ID of the storage pool",
+ "name": "id",
+ "type": "string"
},
{
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the scope of the storage pool",
+ "name": "scope",
"type": "string"
},
{
@@ -3332,75 +3337,60 @@
"type": "integer"
},
{
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
- },
- {
- "description": "the total disk size of the storage pool",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "the Pod ID of the storage pool",
- "name": "podid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
+ {},
{
- "description": "IOPS CloudStack can provision from this storage pool",
- "name": "capacityiops",
- "type": "long"
+ "description": "the date and time the storage pool was created",
+ "name": "created",
+ "type": "date"
},
{
- "description": "the Pod name of the storage pool",
- "name": "podname",
+ "description": "Storage provider for this pool",
+ "name": "provider",
"type": "string"
},
{
- "description": "the name of the cluster for the storage pool",
- "name": "clustername",
+ "description": "the storage pool type",
+ "name": "type",
"type": "string"
},
{
- "description": "the ID of the cluster for the storage pool",
- "name": "clusterid",
+ "description": "the tags for the storage pool",
+ "name": "tags",
"type": "string"
},
{
- "description": "the date and time the storage pool was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
"type": "string"
},
{
- "description": "the ID of the storage pool",
- "name": "id",
- "type": "string"
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
},
{
- "description": "the storage pool path",
- "name": "path",
+ "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 Pod ID of the storage pool",
+ "name": "podid",
+ "type": "string"
},
- {},
{
- "description": "the Zone name of the storage pool",
- "name": "zonename",
+ "description": "the ID of the cluster for the storage pool",
+ "name": "clusterid",
"type": "string"
},
{
- "description": "Storage provider for this pool",
- "name": "provider",
- "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",
@@ -3408,49 +3398,59 @@
"type": "string"
},
{
- "description": "the storage pool type",
- "name": "type",
- "type": "string"
- },
- {},
- {
"description": "the storage pool capabilities",
"name": "storagecapabilities",
"type": "map"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
"type": "string"
},
{
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "IOPS CloudStack can provision from this storage pool",
+ "name": "capacityiops",
+ "type": "long"
+ },
+ {
"description": "the name of the storage pool",
"name": "name",
"type": "string"
},
+ {},
{
- "description": "total min IOPS currently in use by volumes",
- "name": "allocatediops",
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
"type": "long"
},
{
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "total min IOPS currently in use by volumes",
+ "name": "allocatediops",
"type": "long"
},
{
- "description": "the scope of the storage pool",
- "name": "scope",
- "type": "string"
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "storagepoolstatus"
},
{
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
"type": "string"
},
{
- "description": "the tags for the storage pool",
- "name": "tags",
+ "description": "the storage pool path",
+ "name": "path",
"type": "string"
}
]
@@ -3461,16 +3461,25 @@
"name": "updateStoragePool",
"params": [
{
- "description": "false to disable the pool for allocation of new volumes, true to enable it back.",
+ "description": "comma-separated list of tags for the storage pool",
"length": 255,
- "name": "enabled",
+ "name": "tags",
"required": false,
- "type": "boolean"
+ "type": "list"
},
{
- "description": "bytes CloudStack can provision from this storage pool",
+ "description": "Change the name of the storage pool",
"length": 255,
- "name": "capacitybytes",
+ "name": "name",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool",
+ "required": false,
+ "since": "4.15",
+ "type": "string"
+ },
+ {
+ "description": "IOPS CloudStack can provision from this storage pool",
+ "length": 255,
+ "name": "capacityiops",
"required": false,
"type": "long"
},
@@ -3483,60 +3492,50 @@
"type": "uuid"
},
{
- "description": "Change the name of the storage pool",
- "length": 255,
- "name": "name",
- "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool",
- "required": false,
- "since": "4.15",
- "type": "string"
- },
- {
- "description": "IOPS CloudStack can provision from this storage pool",
+ "description": "bytes CloudStack can provision from this storage pool",
"length": 255,
- "name": "capacityiops",
+ "name": "capacitybytes",
"required": false,
"type": "long"
},
{
- "description": "comma-separated list of tags for the storage pool",
+ "description": "false to disable the pool for allocation of new volumes, true to enable it back.",
"length": 255,
- "name": "tags",
+ "name": "enabled",
"required": false,
- "type": "list"
+ "type": "boolean"
}
],
"related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool",
"response": [
{
- "description": "Storage provider for this pool",
- "name": "provider",
+ "description": "the ID of the cluster for the storage pool",
+ "name": "clusterid",
"type": "string"
},
{
- "description": "the date and time the storage pool was created",
- "name": "created",
- "type": "date"
- },
- {},
- {
"description": "the Pod ID of the storage pool",
"name": "podid",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
"type": "string"
},
{
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
"description": "the storage pool capabilities",
"name": "storagecapabilities",
"type": "map"
},
{
- "description": "the hypervisor type of the storage pool",
- "name": "hypervisor",
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
"type": "string"
},
{
@@ -3545,49 +3544,30 @@
"type": "long"
},
{
- "description": "the ID of the cluster for the storage pool",
- "name": "clusterid",
- "type": "string"
- },
- {
- "description": "the total disk size of the storage pool",
- "name": "disksizetotal",
- "type": "long"
- },
- {
"description": "the name of the storage pool",
"name": "name",
"type": "string"
},
{
- "description": "the host's currently used disk size",
- "name": "disksizeused",
- "type": "long"
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "storagepoolstatus"
},
{
"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 tags for the storage pool",
"name": "tags",
"type": "string"
},
{
- "description": "the IP address of the storage pool",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "true if this pool is suitable to migrate a volume, false otherwise",
- "name": "suitableformigration",
- "type": "boolean"
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
+ "type": "long"
},
{
"description": "the storage pool path",
@@ -3595,23 +3575,28 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
},
{
- "description": "the Zone ID of the storage pool",
- "name": "zoneid",
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "total min IOPS currently in use by volumes",
- "name": "allocatediops",
- "type": "long"
+ "description": "Storage provider for this pool",
+ "name": "provider",
+ "type": "string"
},
{
- "description": "the ID of the storage pool",
- "name": "id",
+ "description": "the date and time the storage pool was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
@@ -3620,14 +3605,20 @@
"type": "string"
},
{
- "description": "the Pod name of the storage pool",
- "name": "podname",
+ "description": "the ID of the storage pool",
+ "name": "id",
"type": "string"
},
+ {},
{
- "description": "the state of the storage pool",
- "name": "state",
- "type": "storagepoolstatus"
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
+ "type": "string"
},
{
"description": "the Zone name of the storage pool",
@@ -3635,15 +3626,24 @@
"type": "string"
},
{
- "description": "the overprovisionfactor for the storage pool",
- "name": "overprovisionfactor",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
- {},
{
"description": "the host's currently allocated disk size",
"name": "disksizeallocated",
"type": "long"
+ },
+ {
+ "description": "total min IOPS currently in use by volumes",
+ "name": "allocatediops",
+ "type": "long"
+ },
+ {
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
+ "type": "string"
}
],
"since": "3.0.0"
@@ -3665,33 +3665,33 @@
"related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm",
"response": [
{
- "description": "public vlan range",
- "name": "publicvlan",
- "type": "list"
+ "description": "the systemvm agent version",
+ "name": "version",
+ "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 private MAC address for the system VM",
- "name": "privatemacaddress",
+ "description": "the public netmask for the system VM",
+ "name": "publicnetmask",
"type": "string"
},
{
- "description": "the last disconnected date of host",
- "name": "disconnected",
- "type": "date"
+ "description": "the template ID for the system VM",
+ "name": "templateid",
+ "type": "string"
},
{
- "description": "the first DNS for the system VM",
- "name": "dns1",
+ "description": "the private netmask for the system VM",
+ "name": "privatenetmask",
"type": "string"
},
{
- "description": "the public netmask for the system VM",
- "name": "publicnetmask",
+ "description": "the Zone ID for the system VM",
+ "name": "zoneid",
"type": "string"
},
{
@@ -3700,19 +3700,19 @@
"type": "string"
},
{
- "description": "the private netmask for the system VM",
- "name": "privatenetmask",
+ "description": "the private IP address for the system VM",
+ "name": "privateip",
"type": "string"
},
{
- "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 agent state of the system VM",
- "name": "agentstate",
- "type": "string"
+ "description": "the date and time the system VM was created",
+ "name": "created",
+ "type": "date"
},
{
"description": "the system VM type",
@@ -3720,28 +3720,33 @@
"type": "string"
},
{
- "description": "the systemvm agent version",
- "name": "version",
+ "description": "the state of the system VM",
+ "name": "state",
"type": "string"
},
{
- "description": "the second DNS for the system VM",
- "name": "dns2",
+ "description": "the link local MAC address for the system vm",
+ "name": "linklocalmacaddress",
"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 current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the Zone name for the system VM",
+ "name": "zonename",
+ "type": "string"
},
{
- "description": "the private IP address for the system VM",
- "name": "privateip",
+ "description": "the Pod name for the system VM",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"type": "string"
},
{
@@ -3750,29 +3755,39 @@
"type": "string"
},
{
- "description": "the ID of the system VM",
- "name": "id",
- "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 public MAC address for the system VM",
- "name": "publicmacaddress",
+ "description": "the agent state of the system VM",
+ "name": "agentstate",
"type": "string"
},
{},
{
- "description": "the number of active console sessions for the console proxy system vm",
- "name": "activeviewersessions",
+ "description": "the hostname for the system VM",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
"type": "integer"
},
{
- "description": "the Zone ID for the system VM",
- "name": "zoneid",
- "type": "string"
+ "description": "the last disconnected date of host",
+ "name": "disconnected",
+ "type": "date"
},
{
- "description": "guest vlan range",
- "name": "guestvlan",
+ "description": "public vlan range",
+ "name": "publicvlan",
+ "type": "list"
+ },
+ {
+ "description": "the host ID for the system VM",
+ "name": "hostid",
"type": "string"
},
{
@@ -3781,13 +3796,13 @@
"type": "string"
},
{
- "description": "the link local MAC address for the system vm",
- "name": "linklocalmacaddress",
- "type": "string"
+ "description": "the number of active console sessions for the console proxy system vm",
+ "name": "activeviewersessions",
+ "type": "integer"
},
{
- "description": "the network domain for the system VM",
- "name": "networkdomain",
+ "description": "the public IP address for the system VM",
+ "name": "publicip",
"type": "string"
},
{
@@ -3796,59 +3811,44 @@
"type": "string"
},
{
- "description": "the link local IP address for the system vm",
- "name": "linklocalip",
- "type": "string"
- },
- {
- "description": "the template name for the system VM",
- "name": "templatename",
- "type": "string"
- },
- {
- "description": "the Pod name for the system VM",
- "name": "podname",
+ "description": "the second DNS for the system VM",
+ "name": "dns2",
"type": "string"
},
{
- "description": "the public IP address for the system VM",
- "name": "publicip",
+ "description": "the private MAC address for the system VM",
+ "name": "privatemacaddress",
"type": "string"
},
+ {},
{
- "description": "the template ID for the system VM",
- "name": "templateid",
+ "description": "the link local netmask for the system vm",
+ "name": "linklocalnetmask",
"type": "string"
},
{
- "description": "the hypervisor on which the template runs",
- "name": "hypervisor",
+ "description": "the template name for the system VM",
+ "name": "templatename",
"type": "string"
},
- {},
{
- "description": "the hostname for the system VM",
- "name": "hostname",
+ "description": "the link local IP address for the system vm",
+ "name": "linklocalip",
"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 first DNS for the system VM",
+ "name": "dns1",
"type": "string"
},
{
- "description": "the state of the system VM",
- "name": "state",
+ "description": "the ID of the system VM",
+ "name": "id",
"type": "string"
},
{
- "description": "the date and time the system VM was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the host ID for the system VM",
- "name": "hostid",
+ "description": "the public MAC address for the system VM",
+ "name": "publicmacaddress",
"type": "string"
}
]
@@ -3859,25 +3859,25 @@
"name": "importLdapUsers",
"params": [
{
- "description": "",
+ "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
"length": 255,
- "name": "page",
+ "name": "accounttype",
"required": false,
- "type": "integer"
+ "type": "short"
},
{
- "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
+ "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": "timezone",
+ "name": "account",
"required": false,
"type": "string"
},
{
- "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
+ "description": "List by keyword",
"length": 255,
- "name": "accounttype",
+ "name": "keyword",
"required": false,
- "type": "short"
+ "type": "string"
},
{
"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.",
@@ -3887,20 +3887,11 @@
"type": "string"
},
{
- "description": "Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain",
- "length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "Creates the account under the specified role.",
+ "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
"length": 255,
- "name": "roleid",
- "related": "createRole,importRole,listRoles,updateRole",
+ "name": "timezone",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": "details for account used to store specific parameters",
@@ -3910,74 +3901,83 @@
"type": "map"
},
{
- "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
+ "description": "",
"length": 255,
- "name": "account",
+ "name": "pagesize",
"required": false,
- "type": "string"
+ "type": "integer"
},
{
- "description": "List by keyword",
+ "description": "Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain",
"length": 255,
- "name": "keyword",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"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"
}
],
"related": "searchLdap,listLdapUsers",
"response": [
+ {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "The user's username",
+ "name": "username",
"type": "string"
},
{
- "description": "The user's principle",
- "name": "principal",
+ "description": "The user's firstname",
+ "name": "firstname",
"type": "string"
},
{
- "description": "The user's email",
- "name": "email",
+ "description": "The user's principle",
+ "name": "principal",
"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 lastname",
+ "name": "lastname",
"type": "string"
},
{
- "description": "The user's username",
- "name": "username",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "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 lastname",
- "name": "lastname",
+ "description": "The user's email",
+ "name": "email",
"type": "string"
},
+ {},
{
"description": "the current status of the latest async job acting on this object",
"name": "jobstatus",
"type": "integer"
},
{
- "description": "The user's firstname",
- "name": "firstname",
+ "description": "The user's domain",
+ "name": "domain",
"type": "string"
}
],
@@ -3989,60 +3989,74 @@
"name": "listNetworks",
"params": [
{
- "description": "the zone ID of the network",
+ "description": "list networks by ID",
"length": 255,
- "name": "zoneid",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "id",
+ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"required": false,
"type": "uuid"
},
{
- "description": "List by keyword",
+ "description": "the type of the network. Supported values are: isolated, l2, shared and all",
"length": 255,
- "name": "keyword",
+ "name": "type",
"required": false,
"type": "string"
},
{
- "description": "list networks by network offering ID",
+ "description": "List networks by VPC",
"length": 255,
- "name": "networkofferingid",
- "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings",
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,restartVPC,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
"required": false,
"type": "uuid"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "list objects by project",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
{
- "description": "List networks by VPC",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "vpcid",
- "related": "createVPC,listVPCs,restartVPC,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list networks by network offering ID",
+ "length": 255,
+ "name": "networkofferingid",
+ "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings",
"required": false,
"type": "uuid"
},
{
- "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 ID",
+ "description": "list networks by physical network id",
"length": 255,
- "name": "id",
- "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork",
"required": false,
"type": "uuid"
},
{
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ },
+ {
"description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
"length": 255,
"name": "displaynetwork",
@@ -4051,33 +4065,33 @@
"type": "boolean"
},
{
- "description": "the type of the network. Supported values are: isolated, l2, shared and all",
+ "description": "true if network is system, false otherwise",
"length": 255,
- "name": "type",
+ "name": "issystem",
"required": false,
- "type": "string"
+ "type": "boolean"
},
{
- "description": "list resources by account. Must be used with the domainId parameter.",
+ "description": "",
"length": 255,
- "name": "account",
+ "name": "page",
"required": false,
- "type": "string"
+ "type": "integer"
},
{
- "description": "list networks by restartRequired",
+ "description": "the zone ID of the network",
"length": 255,
- "name": "restartrequired",
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
- "type": "boolean"
+ "type": "uuid"
},
{
- "description": "list objects by project",
+ "description": "the network belongs to VPC",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "name": "forvpc",
"required": false,
- "type": "uuid"
+ "type": "boolean"
},
{
"description": "list networks by ACL (access control list) type. Supported values are account and domain",
@@ -4087,11 +4101,12 @@
"type": "string"
},
{
- "description": "the network belongs to VPC",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "forvpc",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
- "type": "boolean"
+ "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",
@@ -4101,236 +4116,181 @@
"type": "boolean"
},
{
- "description": "List resources by tags (key/value pairs)",
- "length": 255,
- "name": "tags",
- "required": false,
- "type": "map"
- },
- {
- "description": "",
+ "description": "list networks supporting certain services",
"length": 255,
- "name": "pagesize",
+ "name": "supportedservices",
"required": false,
- "type": "integer"
+ "type": "list"
},
{
- "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
+ "description": "list networks available for VM deployment",
"length": 255,
- "name": "isrecursive",
+ "name": "canusefordeploy",
"required": false,
"type": "boolean"
},
{
- "description": "",
+ "description": "type of the traffic",
"length": 255,
- "name": "page",
+ "name": "traffictype",
"required": false,
- "type": "integer"
+ "type": "string"
},
{
- "description": "true if network is system, false otherwise",
+ "description": "true if need to list only networks which support specifying IP ranges",
"length": 255,
- "name": "issystem",
+ "name": "specifyipranges",
"required": false,
"type": "boolean"
},
{
- "description": "list networks supporting certain services",
+ "description": "List by keyword",
"length": 255,
- "name": "supportedservices",
+ "name": "keyword",
"required": false,
- "type": "list"
+ "type": "string"
},
{
- "description": "list networks available for VM deployment",
+ "description": "list networks by restartRequired",
"length": 255,
- "name": "canusefordeploy",
+ "name": "restartrequired",
"required": false,
"type": "boolean"
},
{
- "description": "list networks by physical network id",
- "length": 255,
- "name": "physicalnetworkid",
- "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork",
- "required": false,
- "type": "uuid"
- },
- {
- "description": "type of the traffic",
+ "description": "",
"length": 255,
- "name": "traffictype",
+ "name": "pagesize",
"required": false,
- "type": "string"
+ "type": "integer"
}
],
"related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks",
"response": [
{
- "description": "Name of the VPC to which this network belongs",
- "name": "vpcname",
- "type": "string"
- },
- {},
- {
- "description": "true if network is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
- },
- {
- "description": "the gateway of IPv6 network",
- "name": "ip6gateway",
- "type": "string"
- },
- {
- "description": "name of the network offering the network is created from",
- "name": "networkofferingname",
- "type": "string"
- },
- {
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
- },
- {
- "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": "broadcast uri of the network. This parameter is visible to ROOT admins only",
- "name": "broadcasturi",
- "type": "string"
- },
- {
- "description": "the traffic type of the network",
- "name": "traffictype",
+ "description": "related to what other network configuration",
+ "name": "related",
"type": "string"
},
{
- "description": "If the network has redundant routers enabled",
- "name": "redundantrouter",
- "type": "boolean"
- },
- {
"description": "the network domain",
"name": "networkdomain",
"type": "string"
},
{
- "description": "the network's netmask",
- "name": "netmask",
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
"type": "string"
},
{
- "description": "Broadcast domain type of the network",
- "name": "broadcastdomaintype",
+ "description": "The external id of the network",
+ "name": "externalid",
"type": "string"
},
{
- "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
- "name": "cidr",
+ "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 project name of the address",
+ "name": "project",
"type": "string"
},
{
- "description": "the details of the network",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the first DNS for the network",
- "name": "dns1",
+ "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
+ "name": "cidr",
"type": "string"
},
{
- "description": "display text of the network offering the network is created from",
- "name": "networkofferingdisplaytext",
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
"type": "string"
},
{
- "description": "the domain id of the network owner",
- "name": "domainid",
- "type": "string"
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
+ "type": "boolean"
},
{
- "description": "state of the network",
- "name": "state",
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
"type": "string"
},
{
- "description": "the name of the network",
- "name": "name",
+ "description": "the displaytext of the network",
+ "name": "displaytext",
"type": "string"
},
{
- "description": "true if network is system, false otherwise",
- "name": "issystem",
- "type": "boolean"
- },
- {
"description": "the list of resource tags associated with network",
"name": "tags",
"response": [
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
- "description": "the project name where tag belongs to",
- "name": "project",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "customer associated with the tag",
+ "name": "customer",
"type": "string"
},
{
- "description": "customer associated with the tag",
- "name": "customer",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
}
],
"type": "list"
},
{
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "If the network has redundant routers enabled",
+ "name": "redundantrouter",
+ "type": "boolean"
+ },
+ {},
+ {
"description": "the owner of the network",
"name": "account",
"type": "string"
@@ -4341,58 +4301,129 @@
"type": "string"
},
{
- "description": "the displaytext of the network",
- "name": "displaytext",
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
"type": "string"
},
{
- "description": "true if network supports specifying ip ranges, false otherwise",
- "name": "specifyipranges",
- "type": "boolean"
+ "description": "the traffic type of the network",
+ "name": "traffictype",
+ "type": "string"
},
{
- "description": "true if users from subdomains can access the domain level network",
- "name": "subdomainaccess",
- "type": "boolean"
+ "description": "the name of the network",
+ "name": "name",
+ "type": "string"
},
{
- "description": "true if network can span multiple zones",
- "name": "strechedl2subnet",
- "type": "boolean"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "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": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "acl type - access type to the network",
+ "name": "acltype",
+ "type": "string"
},
+ {},
{
"description": "true if network offering is ip conserve mode enabled",
"name": "networkofferingconservemode",
"type": "boolean"
},
{
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
+ "name": "zonesnetworkspans",
+ "type": "set"
+ },
+ {
+ "description": "ACL name associated with the VPC network",
+ "name": "aclname",
"type": "string"
},
{
- "description": "zone id of the network",
- "name": "zoneid",
+ "description": "the id of the network",
+ "name": "id",
"type": "string"
},
{
- "description": "availability of the network offering the network is created from",
- "name": "networkofferingavailability",
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
+ "type": "boolean"
+ },
+ {
+ "description": "the first DNS for the network",
+ "name": "dns1",
"type": "string"
},
{
- "description": "VPC the network belongs to",
- "name": "vpcid",
+ "description": "the network's gateway",
+ "name": "gateway",
"type": "string"
},
{
- "description": "acl type - access type to the network",
- "name": "acltype",
+ "description": "list networks that are persistent",
+ "name": "ispersistent",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "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",
"type": "string"
},
{
- "description": "network offering id the network is created from",
- "name": "networkofferingid",
+ "description": "the domain id of the network owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "true if network is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "zone id of the network",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
"type": "string"
},
{
@@ -4404,13 +4435,8 @@
"name": "provider",
"response": [
{
- "description": "the provider name",
- "name": "name",
- "type": "string"
- },
- {
- "description": "uuid of the network provider",
- "name": "id",
+ "description": "state of the network provider",
+ "name": "state",
"type": "string"
},
{
@@ -4419,23 +4445,28 @@
"type": "string"
},
{
- "description": "services for this provider",
- "name": "servicelist",
- "type": "list"
- },
- {
"description": "true if individual services can be enabled/disabled",
"name": "canenableindividualservice",
"type": "boolean"
},
{
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
"description": "the destination physical network",
"name": "destinationphysicalnetworkid",
"type": "string"
},
{
- "description": "state of the network provider",
- "name": "state",
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "uuid of the network provider",
+ "name": "id",
"type": "string"
}
],
@@ -4456,13 +4487,13 @@
"type": "boolean"
},
{
- "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"
}
],
@@ -4472,29 +4503,18 @@
"type": "list"
},
{
- "description": "the type of the network",
- "name": "type",
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
"type": "string"
},
- {},
{
- "description": "the project name of the address",
- "name": "project",
+ "description": "name of the network offering the network is created from",
+ "name": "networkofferingname",
"type": "string"
},
{
- "description": "list networks available for vm deployment",
- "name": "canusefordeploy",
- "type": "boolean"
- },
- {
- "description": "an optional field, whether to the display the network to the end user or not.",
- "name": "displaynetwork",
- "type": "boolean"
- },
- {
- "description": "ACL name associated with the VPC network",
- "name": "aclname",
+ "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
+ "name": "broadcasturi",
"type": "string"
},
{
@@ -4503,69 +4523,49 @@
"type": "boolean"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "list networks that are persistent",
- "name": "ispersistent",
- "type": "boolean"
- },
- {
- "description": "related to what other network configuration",
- "name": "related",
+ "description": "the network's netmask",
+ "name": "netmask",
"type": "string"
},
{
- "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans",
- "name": "zonesnetworkspans",
- "type": "set"
+ "description": "true if network is system, false otherwise",
+ "name": "issystem",
+ "type": "boolean"
},
{
- "description": "the project id of the ipaddress",
- "name": "projectid",
- "type": "string"
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
},
{
- "description": "the network's gateway",
- "name": "gateway",
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
"type": "string"
},
{
- "description": "the second DNS for the network",
- "name": "dns2",
+ "description": "state of the network",
+ "name": "state",
"type": "string"
},
{
- "description": "the id of the network",
- "name": "id",
+ "description": "the type of the network",
+ "name": "type",
"type": "string"
},
{
- "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": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
+ "type": "boolean"
},
{
- "description": "the physical network id",
- "name": "physicalnetworkid",
+ "description": "the second DNS for the network",
+ "name": "dns2",
"type": "string"
},
{
"description": "The vlan of the network. This parameter is visible to ROOT admins only",
"name": "vlan",
"type": "string"
- },
- {
- "description": "The external id of the network",
- "name": "externalid",
- "type": "string"
- },
- {
- "description": "the name of the zone the network belongs to",
- "name": "zonename",
- "type": "string"
}
]
},
@@ -4583,21 +4583,14 @@
"type": "uuid"
},
{
- "description": "list dedicated zones by affinity group",
+ "description": "the ID of the domain associated with the zone",
"length": 255,
- "name": "affinitygroupid",
- "related": "createAffinityGroup,listAffinityGroups",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
"type": "uuid"
},
{
- "description": "the name of the account associated with the zone. Must be used with domainId.",
- "length": 255,
- "name": "account",
- "required": false,
- "type": "string"
- },
- {
"description": "List by keyword",
"length": 255,
"name": "keyword",
@@ -4619,19 +4612,31 @@
"type": "integer"
},
{
- "description": "the ID of the domain associated with the zone",
+ "description": "list dedicated zones by affinity group",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "affinitygroupid",
+ "related": "createAffinityGroup,listAffinityGroups",
"required": false,
"type": "uuid"
+ },
+ {
+ "description": "the name of the account associated with the zone. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
}
],
"related": "dedicateZone",
"response": [
{
- "description": "the domain ID to which the Zone is dedicated",
- "name": "domainid",
+ "description": "the ID of the Zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Dedication Affinity Group ID of the zone",
+ "name": "affinitygroupid",
"type": "string"
},
{
@@ -4640,35 +4645,30 @@
"type": "integer"
},
{
- "description": "the Name of the Zone",
- "name": "zonename",
+ "description": "the Account Id to which the Zone is dedicated",
+ "name": "accountid",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "the Name of the Zone",
+ "name": "zonename",
"type": "string"
},
{
- "description": "the Dedication Affinity Group ID of the zone",
- "name": "affinitygroupid",
+ "description": "the domain ID to which the Zone is dedicated",
+ "name": "domainid",
"type": "string"
},
{},
+ {},
{
- "description": "the ID of the dedicated resource",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the Account Id to which the Zone is dedicated",
- "name": "accountid",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
- {},
{
- "description": "the ID of the Zone",
- "name": "zoneid",
+ "description": "the ID of the dedicated resource",
+ "name": "id",
"type": "string"
}
]
@@ -4688,52 +4688,52 @@
],
"related": "",
"response": [
+ {},
{
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
},
{
- "description": "controller of the pool",
- "name": "controllerid",
- "type": "string"
- },
- {
- "description": "the ID of the storage pool",
- "name": "id",
+ "description": "default gateway of the pool",
+ "name": "gateway",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the current available space of the pool",
+ "name": "size",
+ "type": "long"
},
{
- "description": "default gateway of the pool",
- "name": "gateway",
+ "description": "the ID of the storage pool",
+ "name": "id",
"type": "string"
},
+ {},
{
"description": "available iops of the pool",
"name": "maxiops",
"type": "long"
},
{
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "string"
+ },
+ {
"description": "the name of the storage pool",
"name": "name",
"type": "string"
},
{
- "description": "the state of the storage pool",
- "name": "state",
+ "description": "controller of the pool",
+ "name": "controllerid",
"type": "string"
},
- {},
- {},
{
- "description": "the current available space of the pool",
- "name": "size",
- "type": "long"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
]
},
@@ -4770,43 +4770,53 @@
"related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule",
"response": [
{
- "description": "the public ip address id for the firewall rule",
- "name": "ipaddressid",
+ "description": "the state of the rule",
+ "name": "state",
"type": "string"
},
+ {},
{
- "description": "the network id of the firewall rule",
- "name": "networkid",
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
"type": "string"
},
{
- "description": "the state of the rule",
- "name": "state",
- "type": "string"
+ "description": "the public ip address id for the firewall rule",
+ "name": "ipaddressid",
+ "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 protocol of the firewall rule",
+ "name": "protocol",
+ "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",
+ "description": "the domain associated with the tag",
+ "name": "domain",
"type": "string"
},
{
- "description": "the domain associated with the tag",
- "name": "domain",
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the account associated with the tag",
- "name": "account",
+ "description": "tag value",
+ "name": "value",
"type": "string"
},
{
@@ -4815,70 +4825,49 @@
"type": "string"
},
{
- "description": "tag key name",
- "name": "key",
+ "description": "the project name where tag belongs to",
+ "name": "project",
"type": "string"
},
{
- "description": "tag value",
- "name": "value",
+ "description": "id of the resource",
+ "name": "resourceid",
"type": "string"
},
{
- "description": "the project id the tag belongs to",
- "name": "projectid",
+ "description": "tag key name",
+ "name": "key",
"type": "string"
},
{
- "description": "resource type",
- "name": "resourcetype",
+ "description": "the account associated with the tag",
+ "name": "account",
"type": "string"
},
{
- "description": "id of the resource",
- "name": "resourceid",
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
"type": "string"
},
{
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
+ "description": "resource type",
+ "name": "resourcetype",
"type": "string"
}
],
"type": "list"
},
- {},
- {
- "description": "the public ip address for the firewall rule",
- "name": "ipaddress",
- "type": "string"
- },
- {
- "description": "is rule for display to the regular user",
- "name": "fordisplay",
- "type": "boolean"
- },
{
"description": "the starting port of firewall rule's port range",
"name": "startport",
"type": "integer"
},
{
- "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": "the ending port of firewall rule's port range",
- "name": "endport",
- "type": "integer"
- },
- {
"description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
"name": "destcidrlist",
"type": "string"
@@ -4888,20 +4877,31 @@
"name": "id",
"type": "string"
},
+ {},
+ {
+ "description": "the network id of the firewall rule",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address for the firewall rule",
+ "name": "ipaddress",
+ "type": "string"
+ },
{
"description": "error code for this icmp message",
"name": "icmpcode",
"type": "integer"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "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"
}
],
"since": "4.4"
@@ -4913,22 +4913,22 @@
"params": [],
"related": "",
"response": [
- {
- "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"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
}
],
"since": "4.7.0"
@@ -4939,6 +4939,13 @@
"name": "listSrxFirewalls",
"params": [
{
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
"description": "the Physical Network ID",
"length": 255,
"name": "physicalnetworkid",
@@ -4949,7 +4956,7 @@
{
"description": "",
"length": 255,
- "name": "page",
+ "name": "pagesize",
"required": false,
"type": "integer"
},
@@ -4967,41 +4974,34 @@
"name": "keyword",
"required": false,
"type": "string"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
}
],
"related": "addSrxFirewall,configureSrxFirewall",
"response": [
- {},
{
- "description": "the timeout (in seconds) for requests to the external firewall",
- "name": "timeout",
+ "description": "the usage interface of the external firewall",
+ "name": "usageinterface",
"type": "string"
},
+ {},
{
- "description": "the private security zone of the external firewall",
- "name": "privatezone",
+ "description": "the zone ID of the external firewall",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "device capacity",
- "name": "fwdevicecapacity",
- "type": "long"
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
},
{
- "description": "the private interface of the external firewall",
- "name": "privateinterface",
- "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 physical network to which this SRX firewall belongs to",
+ "name": "physicalnetworkid",
"type": "string"
},
{
@@ -5010,64 +5010,64 @@
"type": "string"
},
{
- "description": "the number of times to retry requests to the external firewall",
- "name": "numretries",
+ "description": "the private interface of the external firewall",
+ "name": "privateinterface",
"type": "string"
},
{
- "description": "the management IP address of the external firewall",
- "name": "ipaddress",
+ "description": "the private security zone of the external firewall",
+ "name": "privatezone",
"type": "string"
},
{
- "description": "device id of the SRX firewall",
- "name": "fwdeviceid",
+ "description": "device name",
+ "name": "fwdevicename",
"type": "string"
},
{
- "description": "name of the provider",
- "name": "provider",
+ "description": "device id of the SRX firewall",
+ "name": "fwdeviceid",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
- },
- {
- "description": "device state",
- "name": "fwdevicestate",
+ "description": "the username that's used to log in to the external firewall",
+ "name": "username",
"type": "string"
},
{
- "description": "device name",
- "name": "fwdevicename",
+ "description": "the public interface of the external firewall",
+ "name": "publicinterface",
"type": "string"
},
{
- "description": "the public interface of the external firewall",
- "name": "publicinterface",
+ "description": "the management IP address of the external firewall",
+ "name": "ipaddress",
"type": "string"
},
{},
{
- "description": "the zone ID of the external firewall",
- "name": "zoneid",
+ "description": "device capacity",
+ "name": "fwdevicecapacity",
+ "type": "long"
+ },
+ {
+ "description": "name of the provider",
+ "name": "provider",
"type": "string"
},
{
- "description": "the usage interface of the external firewall",
- "name": "usageinterface",
+ "description": "device state",
+ "name": "fwdevicestate",
"type": "string"
},
{
- "description": "the physical network to which this SRX firewall belongs to",
- "name": "physicalnetworkid",
+ "description": "the number of times to retry requests to the external firewall",
+ "name": "numretries",
"type": "string"
},
{
- "description": "the username that's used to log in to the external firewall",
- "name": "username",
+ "description": "the timeout (in seconds) for requests to the external firewall",
+ "name": "timeout",
"type": "string"
}
]
@@ -5095,27 +5095,27 @@
],
"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"
},
- {},
- {},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
"type": "string"
- }
+ },
+ {}
],
"since": "3.0.0"
},
@@ -5137,8 +5137,8 @@
"response": [
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "description": "Hypervisor name",
+ "name": "name",
"type": "string"
},
{
@@ -5148,8 +5148,8 @@
},
{},
{
- "description": "Hypervisor name",
- "name": "name",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
}
]
@@ -5168,25 +5168,26 @@
"type": "uuid"
},
{
- "description": "Map of (key/value pairs)",
+ "description": "Unique display name for Guest OS",
"length": 255,
- "name": "details",
+ "name": "osdisplayname",
"required": true,
- "type": "map"
+ "type": "string"
},
{
- "description": "Unique display name for Guest OS",
+ "description": "Map of (key/value pairs)",
"length": 255,
- "name": "osdisplayname",
+ "name": "details",
"required": true,
- "type": "string"
+ "type": "map"
}
],
"related": "listOsTypes,addGuestOs",
"response": [
+ {},
{
- "description": "the ID of the OS category",
- "name": "oscategoryid",
+ "description": "the name/description of the OS type",
+ "name": "description",
"type": "string"
},
{
@@ -5194,28 +5195,27 @@
"name": "isuserdefined",
"type": "boolean"
},
+ {},
{
- "description": "the name/description of the OS type",
- "name": "description",
+ "description": "the ID of the OS type",
+ "name": "id",
"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",
"type": "string"
},
- {},
{
- "description": "the ID of the OS type",
- "name": "id",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
- {}
+ {
+ "description": "the ID of the OS category",
+ "name": "oscategoryid",
+ "type": "string"
+ }
],
"since": "4.4.0"
},
@@ -5225,19 +5225,26 @@
"name": "updateResourceLimit",
"params": [
{
- "description": "Update resource for a specified account. Must be used with the domainId parameter.",
+ "description": "Update resource limits for project",
"length": 255,
- "name": "account",
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
- "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.",
+ "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": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "resourcetype",
+ "required": true,
+ "type": "integer"
+ },
+ {
+ "description": "Update resource for a specified account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
"required": false,
- "type": "uuid"
+ "type": "string"
},
{
"description": " Maximum resource limit.",
@@ -5247,17 +5254,10 @@
"type": "long"
},
{
- "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": "resourcetype",
- "required": true,
- "type": "integer"
- },
- {
- "description": "Update resource limits for project",
+ "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
"type": "uuid"
}
@@ -5265,14 +5265,15 @@
"related": "listResourceLimits",
"response": [
{
- "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 ID of the resource limit",
+ "name": "domainid",
"type": "string"
},
+ {},
{
- "description": "the maximum number of the resource. A -1 means the resource currently has no limit.",
- "name": "max",
- "type": "long"
+ "description": "the project name of the resource limit",
+ "name": "project",
+ "type": "string"
},
{
"description": "the account of the resource limit",
@@ -5280,41 +5281,40 @@
"type": "string"
},
{
- "description": "the domain ID of the resource limit",
- "name": "domainid",
- "type": "string"
+ "description": "the maximum number of the resource. A -1 means the resource currently has no limit.",
+ "name": "max",
+ "type": "long"
},
{
- "description": "the project name of the resource limit",
- "name": "project",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
- {},
{
- "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 current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
},
{
- "description": "the domain name of the resource limit",
- "name": "domain",
+ "description": "the project id of the resource limit",
+ "name": "projectid",
"type": "string"
},
{},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
+ "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 project id of the resource limit",
- "name": "projectid",
+ "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 current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the domain name of the resource limit",
+ "name": "domain",
+ "type": "string"
}
]
},
@@ -5334,26 +5334,26 @@
],
"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"
},
+ {
+ "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"
+ },
{}
]
},
@@ -5363,31 +5363,45 @@
"name": "listHostsMetrics",
"params": [
{
- "description": "",
+ "description": "the state of the host",
"length": 255,
- "name": "pagesize",
+ "name": "state",
"required": false,
- "type": "integer"
+ "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 name of the host",
"length": 255,
- "name": "outofbandmanagementpowerstate",
+ "name": "name",
"required": false,
"type": "string"
},
{
- "description": "the state of the host",
+ "description": "if true, list only hosts dedicated to HA",
"length": 255,
- "name": "state",
+ "name": "hahost",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
+ "length": 255,
+ "name": "hypervisor",
"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",
+ "description": "the id of the host",
"length": 255,
- "name": "virtualmachineid",
- "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMS [...]
+ "name": "id",
+ "related": "addHost,cancelHostMaintenance,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
"required": false,
"type": "uuid"
},
@@ -5400,26 +5414,25 @@
"type": "uuid"
},
{
- "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": "",
+ "description": "List by keyword",
"length": 255,
- "name": "page",
+ "name": "keyword",
"required": false,
- "type": "integer"
+ "type": "string"
},
{
- "description": "the id of the host",
+ "description": "",
"length": 255,
- "name": "id",
- "related": "addBaremetalHost,addHost,cancelHostMaintenance,prepareHostForMaintenance,reconnectHost,updateHost,listExternalLoadBalancers",
+ "name": "page",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
"description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
@@ -5437,13 +5450,6 @@
"type": "uuid"
},
{
- "description": "List by keyword",
- "length": 255,
- "name": "keyword",
- "required": false,
- "type": "string"
- },
- {
"description": "list hosts for which out-of-band management is enabled",
"length": 255,
"name": "outofbandmanagementenabled",
@@ -5458,25 +5464,19 @@
"type": "string"
},
{
- "description": "if true, list only hosts dedicated to HA",
- "length": 255,
- "name": "hahost",
- "required": false,
- "type": "boolean"
- },
- {
- "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": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM",
"length": 255,
- "name": "hypervisor",
+ "name": "virtualmachineid",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMS [...]
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "lists hosts existing in particular cluster",
@@ -5490,153 +5490,162 @@
"related": "",
"response": [
{
- "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
- "name": "hahost",
- "type": "boolean"
- },
- {
- "description": "cpu usage disable threshold exceeded",
- "name": "cpudisablethreshold",
- "type": "boolean"
- },
- {
- "description": "the OS category name of the host",
- "name": "oscategoryname",
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
"type": "string"
},
{
- "description": "the number of CPU sockets on the host",
- "name": "cpusockets",
- "type": "integer"
- },
- {
"description": "the date and time the host was removed",
"name": "removed",
"type": "date"
},
{
- "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
- "name": "cpuwithoverprovisioning",
- "type": "string"
- },
- {
- "description": "the date and time the host was last pinged",
- "name": "lastpinged",
- "type": "date"
- },
- {
- "description": "network write in GiB",
- "name": "networkwrite",
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
"type": "string"
},
{
- "description": "the CPU speed of the host",
- "name": "cpuspeed",
- "type": "long"
- },
- {
- "description": "the total disk size of the host",
- "name": "disksizetotal",
- "type": "long"
- },
- {
- "description": "memory allocated notification threshold exceeded",
- "name": "memoryallocatedthreshold",
- "type": "boolean"
- },
- {
- "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
- "name": "memorytotal",
- "type": "long"
- },
- {
- "description": "the Pod ID of the host",
- "name": "podid",
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
"type": "string"
},
{
- "description": "the total memory allocated in GiB",
- "name": "memoryallocatedgb",
+ "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 allocated in MHz",
- "name": "cpuallocatedvalue",
- "type": "long"
- },
- {
- "description": "the OS category ID of the host",
- "name": "oscategoryid",
- "type": "string"
+ "description": "GPU cards present in the host",
+ "name": "gpugroup",
+ "response": [
+ {
+ "description": "the list of enabled vGPUs",
+ "name": "vgpu",
+ "response": [
+ {
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
+ "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 displays per user",
+ "name": "maxheads",
+ "type": "long"
+ },
+ {
+ "description": "Maximum X resolution per display",
+ "name": "maxresolutionx",
+ "type": "long"
+ },
+ {
+ "description": "Model Name of vGPU",
+ "name": "vgputype",
+ "type": "string"
+ },
+ {
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
+ },
+ {
+ "description": "Maximum no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
+ "type": "long"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroupname",
+ "type": "string"
+ }
+ ],
+ "type": "list"
},
{
- "description": "true if the host is disconnected. False otherwise.",
- "name": "disconnected",
- "type": "date"
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
},
{
- "description": "the host HA information information",
- "name": "hostha",
- "type": "hostharesponse"
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
},
{
- "description": "the amount of the host's memory currently allocated in percentage",
- "name": "memoryallocatedpercentage",
- "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 Pod name of the host",
- "name": "podname",
- "type": "string"
+ "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 state of the host",
- "name": "state",
- "type": "status"
+ "description": "the total memory used in GiB",
+ "name": "memoryusedgb",
+ "type": "string"
},
{
- "description": "the total cpu allocated in Ghz",
- "name": "cpuallocatedghz",
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
"type": "string"
},
{
- "description": "the Zone name of the host",
- "name": "zonename",
- "type": "string"
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
},
{
- "description": "the cluster name of the host",
- "name": "clustername",
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
},
{
- "description": "the cluster ID of the host",
- "name": "clusterid",
+ "description": "the host version",
+ "name": "version",
"type": "string"
},
{
- "description": "comma-separated list of tags for the host",
- "name": "hosttags",
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
"type": "string"
},
{
- "description": "true if local storage is active, false otherwise",
- "name": "islocalstorageactive",
+ "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 total cpu capacity in Ghz",
- "name": "cputotalghz",
- "type": "string"
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
},
{
- "description": "the management server ID of the host",
- "name": "managementserverid",
+ "description": "the Zone name of the host",
+ "name": "zonename",
"type": "string"
},
{
@@ -5645,48 +5654,33 @@
"type": "integer"
},
{
- "description": "the hypervisor version",
- "name": "hypervisorversion",
+ "description": "the Pod ID of the host",
+ "name": "podid",
"type": "string"
},
{
- "description": "the host type",
- "name": "type",
- "type": "type"
- },
- {
- "description": "instances on the host",
- "name": "instances",
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "the incoming network traffic on the host",
- "name": "networkkbsread",
- "type": "long"
- },
- {
- "description": "the last annotation set on this host by an admin",
- "name": "annotation",
+ "description": "the cluster name of the host",
+ "name": "clustername",
"type": "string"
},
{
- "description": "Host details in key/value pairs.",
- "name": "details",
- "type": "map"
- },
- {
- "description": "the host version",
- "name": "version",
+ "description": "network read in GiB",
+ "name": "networkread",
"type": "string"
},
{
- "description": "the average cpu load the last minute",
- "name": "cpuloadaverage",
- "type": "double"
+ "description": "memory usage notification threshold exceeded",
+ "name": "memorythreshold",
+ "type": "boolean"
},
{
- "description": "the ID of the host",
- "name": "id",
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
"type": "string"
},
{
@@ -5695,18 +5689,18 @@
"type": "boolean"
},
{
- "description": "the host hypervisor",
- "name": "hypervisor",
- "type": "hypervisortype"
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
},
{
- "description": "the last time this host was annotated",
- "name": "lastannotated",
- "type": "date"
+ "description": "the total cpu capacity in Ghz",
+ "name": "cputotalghz",
+ "type": "string"
},
{
- "description": "the resource state of the host",
- "name": "resourcestate",
+ "description": "the total cpu allocated in Ghz",
+ "name": "cpuallocatedghz",
"type": "string"
},
{
@@ -5714,112 +5708,111 @@
"name": "capabilities",
"type": "string"
},
- {},
{
- "description": "memory usage notification threshold exceeded",
- "name": "memorythreshold",
- "type": "boolean"
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
},
{
- "description": "the host's currently allocated disk size",
- "name": "disksizeallocated",
- "type": "long"
+ "description": "out-of-band management power state",
+ "name": "powerstate",
+ "type": "powerstate"
},
{
- "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
- "name": "hasenoughcapacity",
+ "description": "cpu allocated disable threshold exceeded",
+ "name": "cpuallocateddisablethreshold",
"type": "boolean"
},
{
- "description": "cpu usage notification threshold exceeded",
- "name": "cputhreshold",
- "type": "boolean"
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
},
{
- "description": "network read in GiB",
- "name": "networkread",
+ "description": "the resource state of the host",
+ "name": "resourcestate",
"type": "string"
},
{
- "description": "the cpu average load on the host",
- "name": "cpuloadaverage",
- "type": "double"
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
},
{
- "description": "the amount of the host's CPU currently allocated",
- "name": "cpuallocated",
- "type": "string"
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
},
{
- "description": "true if the host has capability to support UEFI boot",
- "name": "ueficapability",
- "type": "boolean"
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
},
{
- "description": "the total memory used in GiB",
- "name": "memoryusedgb",
+ "description": "the total memory allocated in GiB",
+ "name": "memoryallocatedgb",
"type": "string"
},
{
- "description": "the CPU number of the host",
- "name": "cpunumber",
- "type": "integer"
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
},
{
- "description": "cpu allocated disable threshold exceeded",
- "name": "cpuallocateddisablethreshold",
+ "description": "cpu usage notification threshold exceeded",
+ "name": "cputhreshold",
"type": "boolean"
},
{},
{
- "description": "the amount of the host's memory currently allocated in bytes",
- "name": "memoryallocatedbytes",
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
"type": "long"
},
{
- "description": "events available for the host",
- "name": "events",
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
"type": "string"
},
{
- "description": "the IP address of the host",
- "name": "ipaddress",
+ "description": "instances on the host",
+ "name": "instances",
"type": "string"
},
{
- "description": "the total cpu used in Ghz",
- "name": "cpuusedghz",
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
"type": "string"
},
{
- "description": "the total memory capacity in GiB",
- "name": "memorytotalgb",
+ "description": "the admin that annotated this host",
+ "name": "username",
"type": "string"
},
{
- "description": "memory allocated disable threshold exceeded",
- "name": "memoryallocateddisablethreshold",
- "type": "boolean"
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
},
{
- "description": "the amount of the host's memory currently used",
- "name": "memoryused",
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
"type": "long"
},
{
- "description": "the date and time the host was created",
- "name": "created",
- "type": "date"
- },
- {
- "description": "the host out-of-band management information",
- "name": "outofbandmanagement",
- "type": "outofbandmanagementresponse"
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
},
{
- "description": "the amount of the host's memory currently allocated",
- "name": "memoryallocated",
- "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 outgoing network traffic on the host",
@@ -5827,108 +5820,85 @@
"type": "long"
},
{
- "description": "the amount of the host's CPU currently used",
- "name": "cpuused",
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "hypervisortype"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
"type": "string"
},
{
- "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",
+ "description": "memory allocated disable threshold exceeded",
+ "name": "memoryallocateddisablethreshold",
"type": "boolean"
},
{
- "description": "GPU cards present in the host",
- "name": "gpugroup",
- "response": [
- {
- "description": "GPU cards present in the host",
- "name": "gpugroupname",
- "type": "string"
- },
- {
- "description": "the list of enabled vGPUs",
- "name": "vgpu",
- "response": [
- {
- "description": "Video RAM for this vGPU type",
- "name": "videoram",
- "type": "long"
- },
- {
- "description": "Maximum no. of vgpu per gpu card (pgpu)",
- "name": "maxvgpuperpgpu",
- "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": "Model Name of vGPU",
- "name": "vgputype",
- "type": "string"
- },
- {
- "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",
- "type": "long"
- },
- {
- "description": "Maximum displays per user",
- "name": "maxheads",
- "type": "long"
- },
- {
- "description": "Maximum Y resolution per display",
- "name": "maxresolutiony",
- "type": "long"
- }
- ],
- "type": "list"
- }
- ],
- "type": "list"
+ "description": "network write in GiB",
+ "name": "networkwrite",
+ "type": "string"
},
{
- "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
- "name": "cpuallocatedwithoverprovisioning",
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
"type": "string"
},
{
- "description": "the cluster type of the cluster that host belongs to",
- "name": "clustertype",
+ "description": "the Pod name of the host",
+ "name": "podname",
"type": "string"
},
{
- "description": "the amount of the host's CPU currently allocated in percentage",
- "name": "cpuallocatedpercentage",
+ "description": "the total memory capacity in GiB",
+ "name": "memorytotalgb",
"type": "string"
},
{
- "description": "the Zone ID of the host",
- "name": "zoneid",
+ "description": "the average cpu load the last minute",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "the last annotation set on this host by an admin",
+ "name": "annotation",
"type": "string"
},
{
- "description": "the admin that annotated this host",
- "name": "username",
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
"type": "string"
},
+ {},
{
- "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
- "name": "memorywithoverprovisioning",
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "description": "cpu usage disable threshold exceeded",
+ "name": "cpudisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
"type": "string"
},
{
- "description": "out-of-band management power state",
- "name": "powerstate",
- "type": "powerstate"
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
},
{
"description": "memory usage disable threshold exceeded",
@@ -5936,9 +5906,39 @@
"type": "boolean"
},
{
- "description": "the name of the host",
- "name": "name",
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "events available for the host",
+ "name": "events",
"type": "string"
+ },
+ {
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
+ },
+ {
+ "description": "the total cpu used in Ghz",
+ "name": "cpuusedghz",
+ "type": "string"
+ },
+ {
+ "description": "memory allocated notification threshold exceeded",
+ "name": "memoryallocatedthreshold",
+ "type": "boolean"
}
],
"since": "4.9.3"
@@ -5958,28 +5958,28 @@
}
],
"response": [
+ {},
+ {},
{
- "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"
},
{
- "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",
+ "type": "integer"
+ }
]
},
{
@@ -5988,20 +5988,6 @@
"name": "listAffinityGroups",
"params": [
{
- "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"
- },
- {
- "description": "",
- "length": 255,
- "name": "pagesize",
- "required": false,
- "type": "integer"
- },
- {
"description": "lists affinity groups by virtual machine ID",
"length": 255,
"name": "virtualmachineid",
@@ -6010,11 +5996,19 @@
"type": "uuid"
},
{
- "description": "list resources by account. Must be used with the domainId parameter.",
+ "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",
"length": 255,
- "name": "account",
+ "name": "listall",
"required": false,
- "type": "string"
+ "type": "boolean"
+ },
+ {
+ "description": "list objects by project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
},
{
"description": "list the affinity group by the ID provided",
@@ -6025,40 +6019,40 @@
"type": "uuid"
},
{
- "description": "",
+ "description": "list resources by account. Must be used with the domainId parameter.",
"length": 255,
- "name": "page",
+ "name": "account",
"required": false,
- "type": "integer"
+ "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",
+ "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.",
"length": 255,
- "name": "listall",
+ "name": "isrecursive",
"required": false,
"type": "boolean"
},
{
- "description": "lists affinity groups by type",
+ "description": "List by keyword",
"length": 255,
- "name": "type",
+ "name": "keyword",
"required": false,
"type": "string"
},
{
- "description": "list objects by project",
+ "description": "",
"length": 255,
- "name": "projectid",
- "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "name": "pagesize",
"required": false,
- "type": "uuid"
+ "type": "integer"
},
{
- "description": "List by keyword",
+ "description": "list only resources belonging to the domain specified",
"length": 255,
- "name": "keyword",
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
"required": false,
- "type": "string"
+ "type": "uuid"
},
{
"description": "lists affinity groups by name",
@@ -6068,34 +6062,30 @@
"type": "string"
},
{
- "description": "list only resources belonging to the domain specified",
+ "description": "lists affinity groups by type",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "name": "type",
"required": false,
- "type": "uuid"
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
}
],
"related": "createAffinityGroup",
"response": [
{
- "description": "the description of the affinity group",
- "name": "description",
- "type": "string"
- },
- {
- "description": "the domain ID of the affinity group",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project name of the affinity group",
- "name": "project",
- "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",
+ "description": "the ID of the affinity group",
+ "name": "id",
"type": "string"
},
{
@@ -6104,26 +6094,25 @@
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
},
{
- "description": "the ID of the affinity group",
- "name": "id",
+ "description": "the description of the affinity group",
+ "name": "description",
"type": "string"
},
- {},
{
- "description": "the account owning the affinity group",
- "name": "account",
+ "description": "the project name of the affinity group",
+ "name": "project",
"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",
@@ -6131,10 +6120,21 @@
"type": "string"
},
{
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
"description": "the project ID of the affinity group",
"name": "projectid",
"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",
@@ -6148,12 +6148,11 @@
"name": "registerSSHKeyPair",
"params": [
{
- "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.",
+ "description": "Name of the keypair",
"length": 255,
- "name": "domainid",
- "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
- "required": false,
- "type": "uuid"
+ "name": "name",
+ "required": true,
+ "type": "string"
},
{
"description": "an optional account for the ssh key. Must be used with domainId.",
@@ -6163,9 +6162,9 @@
"type": "string"
},
{
- "description": "Name of the keypair",
- "length": 255,
- "name": "name",
+ "description": "Public key material of the keypair",
+ "length": 5120,
+ "name": "publickey",
"required": true,
"type": "string"
},
@@ -6178,49 +6177,50 @@
"type": "uuid"
},
{
- "description": "Public key material of the keypair",
- "length": 5120,
- "name": "publickey",
- "required": true,
- "type": "string"
+ "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
}
],
"related": "listSSHKeyPairs",
"response": [
{
- "description": "Name of the keypair",
- "name": "name",
+ "description": "the owner of the keypair",
+ "name": "account",
"type": "string"
},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the domain name of the keypair owner",
+ "name": "domain",
+ "type": "string"
},
+ {},
{
"description": "the domain id of the keypair owner",
"name": "domainid",
"type": "string"
},
{
- "description": "the owner of the keypair",
- "name": "account",
- "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": "Fingerprint of the public key",
"name": "fingerprint",
"type": "string"
},
- {},
{
- "description": "the domain name of the keypair owner",
- "name": "domain",
+ "description": "Name of the keypair",
+ "name": "name",
"type": "string"
},
{}
@@ -6244,24 +6244,24 @@
{},
{},
{
- "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"
},
{
+ "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"
}
]
},
@@ -6271,49 +6271,49 @@
"name": "startRollingMaintenance",
"params": [
{
- "description": "optional operation timeout (in seconds) that overrides the global timeout setting",
+ "description": "if rolling mechanism should continue in case of an error",
"length": 255,
- "name": "timeout",
+ "name": "forced",
"required": false,
- "type": "integer"
+ "type": "boolean"
},
{
- "description": "the IDs of the hosts to start maintenance on",
+ "description": "the IDs of the zones to start maintenance on",
"length": 255,
- "name": "hostids",
- "related": "addBaremetalHost,addHost,cancelHostMaintenance,prepareHostForMaintenance,reconnectHost,updateHost,listExternalLoadBalancers",
+ "name": "zoneids",
+ "related": "createZone,updateZone,listZones,listZones",
"required": false,
"type": "list"
},
{
- "description": "if rolling mechanism should continue in case of an error",
+ "description": "the IDs of the clusters to start maintenance on",
"length": 255,
- "name": "forced",
+ "name": "clusterids",
+ "related": "addCluster,listClusters,updateCluster",
"required": false,
- "type": "boolean"
+ "type": "list"
},
{
- "description": "the command to execute while hosts are on maintenance",
+ "description": "the IDs of the hosts to start maintenance on",
"length": 255,
- "name": "payload",
+ "name": "hostids",
+ "related": "addHost,cancelHostMaintenance,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers",
"required": false,
- "type": "string"
+ "type": "list"
},
{
- "description": "the IDs of the clusters to start maintenance on",
+ "description": "the command to execute while hosts are on maintenance",
"length": 255,
- "name": "clusterids",
- "related": "addCluster,listClusters,updateCluster",
+ "name": "payload",
"required": false,
- "type": "list"
+ "type": "string"
},
{
- "description": "the IDs of the zones to start maintenance on",
+ "description": "optional operation timeout (in seconds) that overrides the global timeout setting",
"length": 255,
- "name": "zoneids",
- "related": "createZone,updateZone,listZones,listZones",
+ "name": "timeout",
"required": false,
- "type": "list"
+ "type": "integer"
},
{
"description": "the IDs of the pods to start maintenance on",
@@ -6326,11 +6326,27 @@
],
"related": "",
"response": [
- {},
{
- "description": "the current status of the latest async job acting on this object",
- "name": "jobstatus",
- "type": "integer"
+ "description": "the hosts skipped",
+ "name": "hostsskipped",
+ "response": [
+ {
+ "description": "the name of the skipped host",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the reason to skip the host",
+ "name": "reason",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the skipped host",
+ "name": "hostid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
},
{
"description": "in case of failure, details are displayed",
@@ -6338,12 +6354,6 @@
"type": "string"
},
{
- "description": "indicates if the rolling maintenance operation was successful",
- "name": "success",
- "type": "boolean"
- },
- {},
- {
"description": "the UUID of the latest async job acting on this object",
"name": "jobid",
"type": "string"
@@ -6353,13 +6363,8 @@
"name": "hostsupdated",
"response": [
{
- "description": "the name of the updated host",
- "name": "hostname",
- "type": "string"
- },
- {
- "description": "output of the maintenance script on the host",
- "name": "output",
+ "description": "the ID of the updated host",
+ "name": "hostid",
"type": "string"
},
{
@@ -6373,35 +6378,30 @@
"type": "string"
},
{
- "description": "the ID of the updated host",
- "name": "hostid",
- "type": "string"
- }
- ],
- "type": "list"
- },
- {
- "description": "the hosts skipped",
- "name": "hostsskipped",
- "response": [
- {
- "description": "the reason to skip the host",
- "name": "reason",
- "type": "string"
- },
- {
- "description": "the ID of the skipped host",
- "name": "hostid",
+ "description": "the name of the updated host",
+ "name": "hostname",
"type": "string"
},
{
- "description": "the name of the skipped host",
- "name": "hostname",
+ "description": "output of the maintenance script on the host",
+ "name": "output",
"type": "string"
}
],
"type": "list"
- }
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "indicates if the rolling maintenance operation was successful",
+ "name": "success",
+ "type": "boolean"
+ },
+ {},
+ {}
]
},
{
@@ -6418,18 +6418,18 @@
"type": "boolean"
},
{
- "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "description": "Name of the network ACL list",
"length": 255,
- "name": "customid",
+ "name": "name",
"required": false,
- "since": "4.4",
"type": "string"
},
{
- "description": "Description of the network ACL list",
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
"length": 255,
- "name": "description",
+ "name": "customid",
"required": false,
+ "since": "4.4",
"type": "string"
},
{
@@ -6441,23 +6441,24 @@
"type": "uuid"
},
{
- "description": "Name of the network ACL list",
+ "description": "Description of the network ACL list",
"length": 255,
- "name": "name",
+ "name": "description",
"required": false,
"type": "string"
}
],
"response": [
+ {},
+ {},
{
"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",
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
"type": "string"
},
{
@@ -6466,11 +6467,10 @@
"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.4"
},
@@ -6480,147 +6480,462 @@
"name": "restoreVirtualMachine",
"params": [
{
- "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO",
- "length": 255,
- "name": "templateid",
- "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
- "required": false,
- "type": "uuid"
- },
- {
"description": "Virtual Machine ID",
"length": 255,
"name": "virtualmachineid",
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMS [...]
"required": true,
"type": "uuid"
+ },
+ {
+ "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO",
+ "length": 255,
+ "name": "templateid",
+ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos",
+ "required": false,
+ "type": "uuid"
}
],
"related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,upda [...]
"response": [
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicipid",
- "type": "string"
- },
- {
- "description": "ssh key-pair",
- "name": "keypair",
- "type": "string"
+ "description": "the target memory in vm",
+ "name": "memorytargetkbs",
+ "type": "long"
},
{
- "description": "list of affinity groups associated with the virtual machine",
- "name": "affinitygroup",
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
"response": [
{
- "description": "virtual machine IDs associated with this affinity group",
- "name": "virtualmachineIds",
- "type": "list"
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
},
{
- "description": "the project name of the affinity group",
- "name": "project",
+ "description": "the account owning the security group",
+ "name": "account",
"type": "string"
},
{
- "description": "the type of the affinity group",
- "name": "type",
+ "description": "the description of the security group",
+ "name": "description",
"type": "string"
},
{
- "description": "the name of the affinity group",
+ "description": "the name of the security group",
"name": "name",
"type": "string"
},
{
- "description": "the ID of the affinity group",
- "name": "id",
- "type": "string"
- },
- {
- "description": "the account owning the affinity group",
- "name": "account",
- "type": "string"
+ "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",
+ "type": "integer"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "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 name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ }
+ ],
+ "type": "set"
},
{
- "description": "the description of the affinity group",
- "name": "description",
+ "description": "the project id of the group",
+ "name": "projectid",
"type": "string"
},
{
- "description": "the domain ID of the affinity group",
- "name": "domainid",
+ "description": "the domain name of the security group",
+ "name": "domain",
"type": "string"
},
{
- "description": "the project ID of the affinity group",
- "name": "projectid",
+ "description": "the project name of the group",
+ "name": "project",
"type": "string"
},
{
- "description": "the domain name of the affinity group",
- "name": "domain",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {},
- {
- "description": "OS name of the vm",
- "name": "osdisplayname",
- "type": "string"
- },
- {
- "description": "the ID of the host for the virtual machine",
- "name": "hostid",
- "type": "string"
- },
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the list of ingress rules associated with the security group",
+ "name": "ingressrule",
+ "response": [
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "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"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
{
- "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
- "name": "instancename",
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
"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 speed of each cpu",
+ "name": "cpuspeed",
+ "type": "integer"
},
{
- "description": "the write (io) of disk on the vm",
- "name": "diskiowrite",
- "type": "long"
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
},
{
- "description": "the ID of the virtual machine",
- "name": "id",
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
"type": "string"
},
{
- "description": "the name of the backup offering of the virtual machine",
- "name": "backupofferingname",
- "type": "string"
+ "description": "the memory used by the vm",
+ "name": "memorykbs",
+ "type": "long"
},
{
- "description": "the amount of the vm's CPU currently used",
- "name": "cpuused",
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
"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": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
"type": "string"
},
{
- "description": "the UUID of the latest async job acting on this object",
- "name": "jobid",
- "type": "string"
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
},
- {},
{
- "description": "the user's name who deployed the virtual machine",
- "name": "username",
- "type": "string"
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "type": "set"
},
{
"description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
@@ -6628,43 +6943,64 @@
"type": "string"
},
{
- "description": "the incoming network traffic on the vm",
- "name": "networkkbsread",
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
"type": "long"
},
{
- "description": "State of the Service from LB rule",
- "name": "servicestate",
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
"type": "string"
},
{
- "description": "the write (bytes) of disk on the vm",
- "name": "diskkbswrite",
+ "description": "the write (io) of disk on the vm",
+ "name": "diskiowrite",
"type": "long"
},
{
- "description": "List of UI read-only Vm details as comma separated string.",
- "name": "readonlyuidetails",
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
"type": "string"
},
{
- "description": "the user's ID who deployed the virtual machine",
- "name": "userid",
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
"type": "string"
},
{
- "description": "Guest vm Boot Mode",
- "name": "bootmode",
+ "description": "the state of the virtual machine",
+ "name": "state",
"type": "string"
},
{
- "description": "the virtual network for the service offering",
- "name": "forvirtualnetwork",
- "type": "boolean"
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
},
{
- "description": "the ID of the service offering of the virtual machine",
- "name": "serviceofferingid",
+ "description": "the name of the disk offering of the virtual machine",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
"type": "string"
},
{
@@ -6673,23 +7009,58 @@
"type": "string"
},
{
- "description": "the name of the domain in which the virtual machine exists",
- "name": "domain",
+ "description": "the vgpu type used by the virtual machine",
+ "name": "vgpu",
"type": "string"
},
{
- "description": "true if the password rest feature is enabled, false otherwise",
- "name": "passwordenabled",
- "type": "boolean"
+ "description": "the ID of the disk offering of the virtual machine",
+ "name": "diskofferingid",
+ "type": "string"
},
{
- "description": "Os type ID of the virtual machine",
- "name": "guestosid",
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
"type": "string"
},
{
- "description": "the name of the ISO attached to the virtual machine",
- "name": "isoname",
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the incoming network traffic on the vm",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
"type": "string"
},
{
@@ -6697,28 +7068,38 @@
"name": "nic",
"response": [
{
- "description": "the name of the corresponding network",
- "name": "networkname",
+ "description": "the netmask of the nic",
+ "name": "netmask",
"type": "string"
},
{
- "description": "the broadcast uri of the nic",
- "name": "broadcasturi",
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
"type": "string"
},
{
- "description": "the ID of the nic",
- "name": "id",
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
"type": "string"
},
{
- "description": "ID of the VLAN/VNI if available",
- "name": "vlanid",
- "type": "integer"
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
},
{
- "description": "the ip address of the nic",
- "name": "ipaddress",
+ "description": "the ID of the nic",
+ "name": "id",
"type": "string"
},
{
@@ -6742,9 +7123,9 @@
"type": "string"
},
{
- "description": "the extra dhcp options on the nic",
- "name": "extradhcpoption",
- "type": "list"
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
},
{
"description": "the isolation uri of the nic",
@@ -6752,39 +7133,29 @@
"type": "string"
},
{
- "description": "the isolated private VLAN if available",
- "name": "isolatedpvlan",
- "type": "integer"
- },
- {
- "description": "the cidr of IPv6 network",
- "name": "ip6cidr",
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
"type": "string"
},
{
- "description": "Type of adapter if available",
- "name": "adaptertype",
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
"type": "string"
},
{
- "description": "the netmask of the nic",
- "name": "netmask",
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
"type": "string"
},
{
- "description": "IP addresses associated with NIC found for unmanaged VM",
- "name": "ipaddresses",
- "type": "list"
- },
- {
- "description": "the gateway of the nic",
- "name": "gateway",
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
"type": "string"
},
{
- "description": "true if nic is default, false otherwise",
- "name": "isdefault",
- "type": "boolean"
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
},
{
"description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
@@ -6792,134 +7163,93 @@
"type": "string"
},
{
- "description": "device id for the network when plugged into the virtual machine",
- "name": "deviceid",
- "type": "string"
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
},
{
- "description": "the isolated private VLAN type if available",
- "name": "isolatedpvlantype",
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
"type": "string"
},
{
- "description": "the traffic type of the nic",
- "name": "traffictype",
- "type": "string"
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
},
{
- "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
- "name": "nsxlogicalswitchport",
+ "description": "the name of the corresponding network",
+ "name": "networkname",
"type": "string"
},
{
- "description": "the ID of the corresponding network",
- "name": "networkid",
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
"type": "string"
},
{
- "description": "the IPv6 address of network",
- "name": "ip6address",
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
"type": "string"
},
{
- "description": "Id of the vm to which the nic belongs",
- "name": "virtualmachineid",
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
"type": "string"
}
],
"type": "set"
},
{
- "description": "the ID of the domain in which the virtual machine exists",
- "name": "domainid",
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
"type": "string"
},
{
- "description": "the password (if exists) of the virtual machine",
- "name": "password",
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
"type": "string"
},
{
- "description": "device ID of the root volume",
- "name": "rootdeviceid",
- "type": "long"
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
},
{
- "description": "the ID of the disk offering of the virtual machine",
- "name": "diskofferingid",
+ "description": "the read (io) of disk on the vm",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
"type": "string"
},
{
- "description": "the list of resource tags associated",
- "name": "tags",
- "response": [
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "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"
- }
- ],
- "type": "set"
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
},
{
- "description": "Vm details in key/value pairs.",
- "name": "details",
- "type": "map"
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
},
+ {},
+ {},
{
- "description": "the internal memory that's free in vm or zero if it can not be calculated",
- "name": "memoryintfreekbs",
+ "description": "the number of cpu this virtual machine is running with",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the read (bytes) of disk on the vm",
+ "name": "diskkbsread",
"type": "long"
},
- {},
{
- "description": "public IP address id associated with vm via Static nat rule",
- "name": "publicip",
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
"type": "string"
},
{
@@ -6928,376 +7258,81 @@
"type": "string"
},
{
- "description": "an optional field whether to the display the vm to the end user or not.",
- "name": "displayvm",
- "type": "boolean"
- },
- {
- "description": "the name of the disk offering of the virtual machine",
- "name": "diskofferingname",
+ "description": "the ID of the availablility zone for the virtual machine",
+ "name": "zoneid",
"type": "string"
},
{
- "description": "true if high-availability is enabled, false otherwise",
- "name": "haenable",
- "type": "boolean"
- },
- {
- "description": "the speed of each cpu",
- "name": "cpuspeed",
- "type": "integer"
- },
- {
- "description": "the account associated with the virtual machine",
- "name": "account",
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
"type": "string"
},
{
- "description": "an alternate display text of the ISO attached to the virtual machine",
- "name": "isodisplaytext",
- "type": "string"
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
},
{
- "description": "OS type id of the vm",
- "name": "ostypeid",
- "type": "string"
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
},
{
- "description": "the state of the virtual machine",
- "name": "state",
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
"type": "string"
},
{
- "description": "the number of cpu this virtual machine is running with",
- "name": "cpunumber",
- "type": "integer"
- },
- {
- "description": "list of security groups associated with the virtual machine",
- "name": "securitygroup",
+ "description": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
"response": [
{
- "description": "the account owning the security group",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project name of the group",
- "name": "project",
+ "description": "the description of the affinity group",
+ "name": "description",
"type": "string"
},
{
- "description": "the ID of the security group",
- "name": "id",
- "type": "string"
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
},
{
- "description": "the project id of the group",
+ "description": "the project ID of the affinity group",
"name": "projectid",
"type": "string"
},
{
- "description": "the list of ingress rules associated with the security group",
- "name": "ingressrule",
- "response": [
- {
- "description": "account owning the security group rule",
- "name": "account",
- "type": "string"
- },
- {
- "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 CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "id of the resource",
- "name": "resourceid",
- "type": "string"
- },
- {
- "description": "the project name where tag belongs to",
- "name": "project",
- "type": "string"
- },
- {
- "description": "tag value",
- "name": "value",
- "type": "string"
- },
- {
- "description": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- }
- ],
- "type": "set"
- },
- {
- "description": "the protocol of the security group rule",
- "name": "protocol",
- "type": "string"
- },
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "security group name",
- "name": "securitygroupname",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- }
- ],
- "type": "set"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "name": "tags",
- "response": [
- {
- "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": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "the account associated with the tag",
- "name": "account",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the domain associated with the tag",
- "name": "domain",
- "type": "string"
- },
- {
- "description": "customer associated with the tag",
- "name": "customer",
- "type": "string"
- }
- ],
- "type": "set"
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
},
{
- "description": "the list of virtualmachine ids associated with this securitygroup",
- "name": "virtualmachineids",
- "type": "set"
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
},
{
- "description": "the domain ID of the security group",
+ "description": "the domain ID of the affinity group",
"name": "domainid",
"type": "string"
},
{
- "description": "the description of the security group",
- "name": "description",
+ "description": "the ID of the affinity group",
+ "name": "id",
"type": "string"
},
{
- "description": "the name of the security group",
+ "description": "the name of the affinity group",
"name": "name",
"type": "string"
},
{
- "description": "the number of virtualmachines associated with this securitygroup",
- "name": "virtualmachinecount",
- "type": "integer"
- },
- {
- "description": "the list of egress rules associated with the security group",
- "name": "egressrule",
- "response": [
- {
- "description": "the starting IP of the security group rule",
- "name": "startport",
- "type": "integer"
- },
- {
- "description": "the type of the ICMP message response",
- "name": "icmptype",
- "type": "integer"
- },
- {
- "description": "the ending IP of the security group rule ",
- "name": "endport",
- "type": "integer"
- },
- {
- "description": "the CIDR notation for the base IP address of the security group rule",
- "name": "cidr",
- "type": "string"
- },
- {
- "description": "the code for the ICMP message response",
- "name": "icmpcode",
- "type": "integer"
- },
- {
- "description": "the list of resource tags associated with the rule",
- "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": "resource type",
- "name": "resourcetype",
- "type": "string"
- },
- {
- "description": "tag key name",
- "name": "key",
- "type": "string"
- },
- {
- "description": "the ID of the domain associated with the tag",
- "name": "domainid",
- "type": "string"
- },
- {
- "description": "the project id the tag belongs to",
- "name": "projectid",
... 155437 lines suppressed ...