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 2024/03/21 09:59:20 UTC
(cloudstack-cloudmonkey) 02/02: precache: update cmk precache to ACS v4.19
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-cloudmonkey.git
commit f1e0e36690791cc227dc082a20c18cd0d66db61e
Author: Rohit Yadav <ro...@shapeblue.com>
AuthorDate: Thu Mar 21 15:28:19 2024 +0530
precache: update cmk precache to ACS v4.19
Signed-off-by: Rohit Yadav <ro...@shapeblue.com>
---
config/precache.go | 141936 +++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 141935 insertions(+), 1 deletion(-)
diff --git a/config/precache.go b/config/precache.go
index 077a456..6a7af6b 100644
--- a/config/precache.go
+++ b/config/precache.go
@@ -17,4 +17,141938 @@
package config
-var preCache = `{"api":[{"description":"Creates VPC offering","isasync":true,"name":"createVPCOffering","params":[{"description":"the name of the vpc offering","length":255,"name":"name","required":true,"type":"string"},{"description":"services supported by the vpc offering","length":255,"name":"supportedservices","required":true,"type":"list"},{"description":"provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physica [...]
+var preCache = `{
+ "api": [
+ {
+ "description": "Lists the resource icon for the specified resource(s)",
+ "isasync": false,
+ "name": "listResourceIcon",
+ "params": [
+ {
+ "description": "type of the resource",
+ "length": 255,
+ "name": "resourcetype",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "list of resources to upload the icon/image for",
+ "length": 255,
+ "name": "resourceids",
+ "required": true,
+ "type": "list"
+ }
+ ],
+ "related": "",
+ "response": [
+ {
+ "description": "base64 representation of resource icon",
+ "name": "base64image",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "resourceobjecttype"
+ },
+ {},
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
+ ],
+ "since": "4.16.0.0"
+ },
+ {
+ "description": "Creates VPC offering",
+ "isasync": true,
+ "name": "createVPCOffering",
+ "params": [
+ {
+ "description": "the ID of the containing zone(s), null for public offerings",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "since": "4.13",
+ "type": "list"
+ },
+ {
+ "description": "services supported by the vpc offering",
+ "length": 255,
+ "name": "supportedservices",
+ "required": true,
+ "type": "list"
+ },
+ {
+ "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": "desired service capabilities as part of vpc offering",
+ "length": 255,
+ "name": "servicecapabilitylist",
+ "required": false,
+ "since": "4.4",
+ "type": "map"
+ },
+ {
+ "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6",
+ "length": 255,
+ "name": "internetprotocol",
+ "required": false,
+ "since": "4.17.0",
+ "type": "string"
+ },
+ {
+ "description": "the name of the vpc offering",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "set to true if the offering is to be enabled during creation. Default is false",
+ "length": 255,
+ "name": "enable",
+ "required": false,
+ "since": "4.16",
+ "type": "boolean"
+ },
+ {
+ "description": "the display text of the vpc offering, defaults to the 'name'",
+ "length": 255,
+ "name": "displaytext",
+ "required": false,
+ "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,moveDomain",
+ "required": false,
+ "type": "list"
+ }
+ ],
+ "related": "updateVPCOffering,listVPCOfferings",
+ "response": [
+ {
+ "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the date this vpc offering was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the list of supported services",
+ "name": "service",
+ "response": [
+ {
+ "description": "the service provider name",
+ "name": "provider",
+ "response": [
+ {
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the list of capabilities",
+ "name": "capability",
+ "response": [
+ {
+ "description": "the capability value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "can this service capability value can be choosable while creatine network offerings",
+ "name": "canchooseservicecapability",
+ "type": "boolean"
+ },
+ {
+ "description": "the capability name",
+ "name": "name",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "state of the vpc offering. Can be Disabled/Enabled",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": " indicates if the vpc offering supports distributed router for one-hop forwarding",
+ "name": "distributedvpcrouter",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the id of the vpc offering",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the internet protocol of the vpc offering",
+ "name": "internetprotocol",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the vpc offering.",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "true if vpc offering is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": " indicated if the offering can support region level vpc",
+ "name": "supportsregionLevelvpc",
+ "type": "boolean"
+ },
+ {
+ "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.",
+ "name": "domainid",
+ "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 current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the vpc offering",
+ "name": "name",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Creates a new Pod.",
+ "isasync": false,
+ "name": "createPod",
+ "params": [
+ {
+ "description": "Allocation state of this Pod for allocation of new resources",
+ "length": 255,
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID in which the Pod will be created",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the name of the Pod",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "the netmask for the Pod",
+ "length": 255,
+ "name": "netmask",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ending IP address for the Pod",
+ "length": 255,
+ "name": "endip",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the starting IP address for the Pod",
+ "length": 255,
+ "name": "startip",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the Pod",
+ "length": 255,
+ "name": "gateway",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "response": [
+ {
+ "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.",
+ "name": "vlanid",
+ "type": "list"
+ },
+ {
+ "description": "the Zone ID of the Pod",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the IP ranges for the Pod",
+ "name": "ipranges",
+ "response": [
+ {
+ "description": "indicates Vlan ID for the range",
+ "name": "vlanid",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP for the range",
+ "name": "startip",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP for the range",
+ "name": "endip",
+ "type": "string"
+ },
+ {
+ "description": "indicates if range is dedicated for CPVM and SSVM",
+ "name": "forsystemvms",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the range",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR for the range",
+ "name": "cidr",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the Zone name of the Pod",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.",
+ "name": "forsystemvms",
+ "type": "list"
+ },
+ {
+ "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.",
+ "name": "endip",
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the netmask of the Pod",
+ "name": "netmask",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the capacity of the Pod",
+ "name": "capacity",
+ "response": [
+ {
+ "description": "the Zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the capacity currently in use",
+ "name": "capacityused",
+ "type": "long"
+ },
+ {
+ "description": "the Cluster ID",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the capacity name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the capacity currently in allocated",
+ "name": "capacityallocated",
+ "type": "long"
+ },
+ {
+ "description": "the capacity type",
+ "name": "type",
+ "type": "short"
+ },
+ {
+ "description": "the Pod name",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the total capacity available",
+ "name": "capacitytotal",
+ "type": "long"
+ },
+ {
+ "description": "the percentage of capacity currently in use",
+ "name": "percentused",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the Cluster name",
+ "name": "clustername",
+ "type": "string"
+ }
+ ],
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the gateway of the Pod",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.",
+ "name": "startip",
+ "type": "list"
+ },
+ {
+ "description": "the ID of the Pod",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Pod",
+ "name": "name",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Creates an account from an LDAP user",
+ "isasync": false,
+ "name": "ldapCreateAccount",
+ "params": [
+ {
+ "description": "Creates the account under the specified role.",
+ "length": 255,
+ "name": "roleid",
+ "related": "createRole,importRole,listRoles,updateRole",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
+ "length": 255,
+ "name": "accounttype",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "Network domain for the account's networks",
+ "length": 255,
+ "name": "networkdomain",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Account UUID, required for adding account from external provisioning system",
+ "length": 255,
+ "name": "accountid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "details for account used to store specific parameters",
+ "length": 255,
+ "name": "accountdetails",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "User UUID, required for adding account from external provisioning system",
+ "length": 255,
+ "name": "userid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Unique username.",
+ "length": 255,
+ "name": "username",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
+ "length": 255,
+ "name": "timezone",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Creates the user under the specified domain.",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain",
+ "required": false,
+ "type": "uuid"
+ }
+ ],
+ "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts",
+ "response": [
+ {
+ "description": "the total number of virtual machines deployed by this account",
+ "name": "vmtotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of networks the account can own",
+ "name": "networklimit",
+ "type": "string"
+ },
+ {
+ "description": "the name of the account",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "account type (admin, domain-admin, user)",
+ "name": "accounttype",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this account",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of virtual machines stopped for this account",
+ "name": "vmstopped",
+ "type": "integer"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) available to be used for this account",
+ "name": "secondarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) the account can own",
+ "name": "memorylimit",
+ "type": "string"
+ },
+ {
+ "description": "details for the account",
+ "name": "accountdetails",
+ "type": "map"
+ },
+ {
+ "description": "the default zone of the account",
+ "name": "defaultzoneid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects the account can own",
+ "name": "projectlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this account",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "id of the Domain the account belongs to",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the date when this account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the total number of public ip addresses available for this account to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "true if the account requires cleanup",
+ "name": "iscleanuprequired",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates available to be created by this account",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which can be created by this account",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the total number of vpcs the account can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {
+ "description": "the id of the account",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) the account can own",
+ "name": "primarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "path of the Domain the account belongs to",
+ "name": "domainpath",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which have been created by this account",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the total volume which can be used by this account",
+ "name": "volumelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects available for administration by this account",
+ "name": "projectavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) the account can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines running for this account",
+ "name": "vmrunning",
+ "type": "integer"
+ },
+ {
+ "description": "the total memory (in MB) owned by account",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this account",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total primary storage space (in GiB) available to be used for this account",
+ "name": "primarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores the account can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines available for this account to acquire",
+ "name": "vmavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this account",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by account",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "the total number of cpu cores available to be created for this account",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "name of the Domain the account belongs to",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this account",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks owned by account",
+ "name": "networktotal",
+ "type": "long"
+ },
+ {
+ "description": "the total memory (in MB) available to be created for this account",
+ "name": "memoryavailable",
+ "type": "string"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores owned by account",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the total primary storage space (in GiB) owned by account",
+ "name": "primarystoragetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of snapshots available for this account",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "the total number of vpcs owned by account",
+ "name": "vpctotal",
+ "type": "long"
+ },
+ {
+ "description": "the list of acl groups that account belongs to",
+ "name": "groups",
+ "type": "list"
+ },
+ {
+ "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects being administrated by this account",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
+ "description": "the state of the account",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of public ip addresses this account can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total volume being used by this account",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "description": "true if account is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the total number of networks available to be created for this account",
+ "name": "networkavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots stored by this account",
+ "name": "snapshottotal",
+ "type": "long"
+ },
+ {
+ "description": "the list of users associated with account",
+ "name": "user",
+ "response": [
+ {
+ "description": "the secret key of the user",
+ "name": "secretkey",
+ "type": "string"
+ },
+ {
+ "description": "the user name",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the user",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account ID of the user",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the user firstname",
+ "name": "firstname",
+ "type": "string"
+ },
+ {
+ "description": "the account name of the user",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "true if user is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the user email address",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the user",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the user lastname",
+ "name": "lastname",
+ "type": "string"
+ },
+ {
+ "description": "the user ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the account type of the user",
+ "name": "accounttype",
+ "type": "integer"
+ },
+ {
+ "description": "the api key of the user",
+ "name": "apikey",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the user account was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the user state",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "true if user has two factor authentication is mandated",
+ "name": "is2famandated",
+ "type": "boolean"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the type of the role",
+ "name": "roletype",
+ "type": "string"
+ },
+ {
+ "description": "the boolean value representing if the updating target is in caller's child domain",
+ "name": "iscallerchilddomain",
+ "type": "boolean"
+ },
+ {
+ "description": "the source type of the user in lowercase, such as native, ldap, saml2",
+ "name": "usersource",
+ "type": "string"
+ },
+ {
+ "description": "the timezone user was created in",
+ "name": "timezone",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the role",
+ "name": "roleid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the role",
+ "name": "rolename",
+ "type": "string"
+ },
+ {
+ "description": "true if user has two factor authentication enabled",
+ "name": "is2faenabled",
+ "type": "boolean"
+ }
+ ],
+ "type": "list"
+ }
+ ],
+ "since": "4.2.0"
+ },
+ {
+ "description": "Safely removes raw records from cloud_usage table",
+ "isasync": false,
+ "name": "removeRawUsageRecords",
+ "params": [
+ {
+ "description": "Specify the number of days (greater than zero) to remove records that are older than those number of days from today. For example, specifying 10 would result in removing all the records created before 10 days from today",
+ "length": 255,
+ "name": "interval",
+ "required": true,
+ "type": "integer"
+ }
+ ],
+ "response": [
+ {
+ "description": "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"
+ },
+ {},
+ {}
+ ],
+ "since": "4.6.0"
+ },
+ {
+ "description": "Copies an iso from one zone to another.",
+ "isasync": true,
+ "name": "copyIso",
+ "params": [
+ {
+ "description": "ID of the zone the template is being copied to.",
+ "length": 255,
+ "name": "destzoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.",
+ "length": 255,
+ "name": "destzoneids",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "Template ID.",
+ "length": 255,
+ "name": "id",
+ "related": "prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.",
+ "length": 255,
+ "name": "sourcezoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ }
+ ],
+ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
+ "response": [
+ {
+ "description": "the ID of the domain to which the template belongs",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the tag of this template",
+ "name": "templatetag",
+ "type": "string"
+ },
+ {
+ "description": "the template ID of the parent template if present",
+ "name": "sourcetemplateid",
+ "type": "string"
+ },
+ {
+ "description": "the id of userdata linked to this template",
+ "name": "userdataid",
+ "type": "string"
+ },
+ {
+ "description": "the size of the template",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "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": "true if this template is a public template, false otherwise",
+ "name": "ispublic",
+ "type": "boolean"
+ },
+ {
+ "description": "the format of the template.",
+ "name": "format",
+ "type": "imageformat"
+ },
+ {
+ "description": "if root disk template, then ids of the datas disk templates this template owns",
+ "name": "childtemplates",
+ "type": "set"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the template ID",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if template is sshkey enabled, false otherwise",
+ "name": "sshkeyenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "if Datadisk template, then id of the root disk template this template belongs to",
+ "name": "parenttemplateid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the domain to which the template belongs",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the name of userdata linked to this template",
+ "name": "userdataname",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the template",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "true if the ISO is bootable, false otherwise",
+ "name": "bootable",
+ "type": "boolean"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "true if this template is a featured template, false otherwise",
+ "name": "isfeatured",
+ "type": "boolean"
+ },
+ {
+ "description": "the date this template was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the zone for this template",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the date this template was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if the reset password feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the zone for this template",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ID of the OS type for this template.",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "Lists the download progress of a template across all secondary storages",
+ "name": "downloaddetails",
+ "type": "list"
+ },
+ {
+ "description": "the physical size of the template",
+ "name": "physicalsize",
+ "type": "long"
+ },
+ {
+ "description": "VMware only: additional key/value details tied with deploy-as-is template",
+ "name": "deployasisdetails",
+ "type": "map"
+ },
+ {
+ "description": "the URL which the template/iso is registered from",
+ "name": "url",
+ "type": "string"
+ },
+ {
+ "description": "the processor bit size",
+ "name": "bits",
+ "type": "int"
+ },
+ {
+ "description": "checksum of the template",
+ "name": "checksum",
+ "type": "string"
+ },
+ {
+ "description": "true if the template is extractable, false otherwise",
+ "name": "isextractable",
+ "type": "boolean"
+ },
+ {
+ "description": "the account name to which the template belongs",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "true if template requires HVM enabled, false otherwise",
+ "name": "requireshvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the userdata override policy with the userdata provided while deploying VM",
+ "name": "userdatapolicy",
+ "type": "string"
+ },
+ {
+ "description": "the template display text",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the name of the OS type for this template.",
+ "name": "ostypename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the secondary storage host for the template",
+ "name": "hostname",
+ "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 status of the template",
+ "name": "status",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the project name of the template",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "additional key/value details tied with template",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the secondary storage host for the template",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata",
+ "name": "userdataparams",
+ "type": "string"
+ },
+ {
+ "description": "true if the template is managed across all Zones, false otherwise",
+ "name": "crossZones",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the type of the template",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {
+ "description": "the account id to which the template belongs",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage",
+ "name": "directdownload",
+ "type": "boolean"
+ }
+ ]
+ },
+ {
+ "description": "Deletes a autoscale vm profile.",
+ "isasync": true,
+ "name": "deleteAutoScaleVmProfile",
+ "params": [
+ {
+ "description": "the ID of the autoscale profile",
+ "length": 255,
+ "name": "id",
+ "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "response": [
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
+ ]
+ },
+ {
+ "description": "Issues and propagates client certificate on a connected host/agent using configured CA plugin",
+ "isasync": true,
+ "name": "provisionCertificate",
+ "params": [
+ {
+ "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)",
+ "length": 255,
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used",
+ "length": 255,
+ "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": "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"
+ }
+ ],
+ "since": "4.11.0"
+ },
+ {
+ "description": "Lists VM metrics",
+ "isasync": false,
+ "name": "listVirtualMachinesMetrics",
+ "params": [
+ {
+ "description": "the availability zone ID",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "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",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.",
+ "length": 255,
+ "name": "accumulate",
+ "required": false,
+ "since": "4.17.0",
+ "type": "boolean"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list by the service offering",
+ "length": 255,
+ "name": "serviceofferingid",
+ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings",
+ "required": false,
+ "since": "4.4",
+ "type": "uuid"
+ },
+ {
+ "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.",
+ "length": 255,
+ "name": "isvnf",
+ "required": false,
+ "since": "4.19.0",
+ "type": "boolean"
+ },
+ {
+ "description": "the security group ID",
+ "length": 255,
+ "name": "securitygroupid",
+ "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup",
+ "required": false,
+ "since": "4.15",
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of AutoScaling VM Group",
+ "length": 255,
+ "name": "autoscalevmgroupid",
+ "related": "createAutoScaleVmGroup,disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup",
+ "required": false,
+ "since": "4.18.0",
+ "type": "uuid"
+ },
+ {
+ "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.",
+ "length": 255,
+ "name": "userdata",
+ "required": false,
+ "since": "4.18.0.0",
+ "type": "boolean"
+ },
+ {
+ "description": "makes the API's response contains only the resource count",
+ "length": 255,
+ "name": "retrieveonlyresourcecount",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "flag to display the resource icon for VMs",
+ "length": 255,
+ "name": "showicon",
+ "required": false,
+ "since": "4.16.0.0",
+ "type": "boolean"
+ },
+ {
+ "description": "the user ID that created the VM and is under the account that owns the VM",
+ "length": 255,
+ "name": "userid",
+ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the pod ID",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the host ID",
+ "length": 255,
+ "name": "hostid",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the target hypervisor for the template",
+ "length": 255,
+ "name": "hypervisor",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list by network type; true if need to list vms using Virtual Network, false otherwise",
+ "length": 255,
+ "name": "forvirtualnetwork",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list vms by iso",
+ "length": 255,
+ "name": "isoid",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "length": 255,
+ "name": "id",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtua [...]
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list vms by affinity group",
+ "length": 255,
+ "name": "affinitygroupid",
+ "related": "createAffinityGroup,listAffinityGroups",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list objects by project; if projectid=-1 lists All VMs",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list vms by template",
+ "length": 255,
+ "name": "templateid",
+ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list by the backup offering",
+ "length": 255,
+ "name": "backupofferingid",
+ "required": false,
+ "since": "4.17",
+ "type": "uuid"
+ },
+ {
+ "description": "the storage ID where vm's volumes belong to",
+ "length": 255,
+ "name": "storageid",
+ "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "length": 255,
+ "name": "displayvm",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "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": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled",
+ "length": 255,
+ "name": "haenable",
+ "required": false,
+ "since": "4.15",
+ "type": "boolean"
+ },
+ {
+ "description": "the IDs of the virtual machines, mutually exclusive with id",
+ "length": 255,
+ "name": "ids",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtua [...]
+ "required": false,
+ "since": "4.4",
+ "type": "list"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list vms by ssh keypair name",
+ "length": 255,
+ "name": "keypair",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the group ID",
+ "length": 255,
+ "name": "groupid",
+ "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup",
+ "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": "list by network id",
+ "length": 255,
+ "name": "networkid",
+ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the cluster ID",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster,listClusters,updateCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list vms by vpc",
+ "length": 255,
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List resources by tags (key/value pairs)",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "map"
+ }
+ ],
+ "related": "listVirtualMachinesMetrics",
+ "response": [
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "network read in MiB",
+ "name": "networkread",
+ "type": "string"
+ },
+ {
+ "description": "the type of the template for the virtual machine",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "the read (IO) of disk on the VM",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag value",
+ "name": "value",
+ "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 domain associated with the tag",
+ "name": "domain",
+ "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"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {},
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the vGPU type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "list of variables and values for the variables declared in userdata",
+ "name": "userdatadetails",
+ "type": "string"
+ },
+ {
+ "description": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
+ "response": [
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each vCPU",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "the number of vCPUs this virtual machine is using",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "disk write in MiB",
+ "name": "diskwrite",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the write (IO) of disk on the VM",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with this nic via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vpc to which the nic belongs",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "ID of the VLAN/VNI if available",
+ "name": "vlanid",
+ "type": "integer"
+ },
+ {
+ "description": "public IP address associated with this nic via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "IP addresses associated with NIC found for unmanaged VM",
+ "name": "ipaddresses",
+ "type": "list"
+ },
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "name of the vpc to which the nic belongs",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "MTU configured on the NIC",
+ "name": "mtu",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "the userdata override policy with the userdata provided while deploying VM",
+ "name": "userdatapolicy",
+ "type": "string"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the VM's primary IP address",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "the control state of the host for the virtual machine",
+ "name": "hostcontrolstate",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "VNF details",
+ "name": "vnfdetails",
+ "type": "map"
+ },
+ {
+ "description": "network write in MiB",
+ "name": "networkwrite",
+ "type": "string"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the incoming network traffic on the VM in KiB",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "the memory used by the VM in KiB",
+ "name": "memorykbs",
+ "type": "long"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "NICs of the VNF appliance",
+ "name": "vnfnics",
+ "type": "list"
+ },
+ {
+ "description": "the id of userdata used for the VM",
+ "name": "userdataid",
+ "type": "string"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the VM's disk write in KiB",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the total cpu capacity in Ghz",
+ "name": "cputotal",
+ "type": "string"
+ },
+ {
+ "description": "the total disk iops",
+ "name": "diskiopstotal",
+ "type": "long"
+ },
+ {
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
+ "response": [
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the description of the security group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "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"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ID of the security group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "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": "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 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 list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "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"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "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"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the list of egress rules associated with the security group",
+ "name": "egressrule",
+ "response": [
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the code for the ICMP message response",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "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": "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 account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ }
+ ],
+ "type": "set"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "ssh key-pairs",
+ "name": "keypairs",
+ "type": "string"
+ },
+ {
+ "description": "disk read in MiB",
+ "name": "diskread",
+ "type": "string"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the availability zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the name of userdata used for the VM",
+ "name": "userdataname",
+ "type": "string"
+ },
+ {
+ "description": "Name of AutoScale VM group",
+ "name": "autoscalevmgroupname",
+ "type": "string"
+ },
+ {
+ "description": "the VM's disk read in KiB",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the total memory capacity in GiB",
+ "name": "memorytotal",
+ "type": "string"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "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 name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string containing the user data",
+ "name": "userdata",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the target memory in VM (KiB)",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "ID of AutoScale VM group",
+ "name": "autoscalevmgroupid",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host in KiB",
+ "name": "networkkbswrite",
+ "type": "long"
+ }
+ ]
+ },
+ {
+ "description": "Lists hosts.",
+ "isasync": false,
+ "name": "listHosts",
+ "params": [
+ {
+ "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": "the state of the host",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "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": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list hosts for which out-of-band management is enabled",
+ "length": 255,
+ "name": "outofbandmanagementenabled",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the Pod ID for the host",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the name of the host",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
+ "length": 255,
+ "name": "hypervisor",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the id of the host",
+ "length": 255,
+ "name": "id",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "lists hosts existing in particular cluster",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster,listClusters,updateCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "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",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtua [...]
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "if true, list only hosts dedicated to HA",
+ "length": 255,
+ "name": "hahost",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the Zone ID for the host",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "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"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the host type",
+ "length": 255,
+ "name": "type",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "response": [
+ {
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "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",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the last annotation set on this host by an admin",
+ "name": "annotation",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "Whether the informed tag is a JS interpretable rule or not.",
+ "name": "istagarule",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "type": "string"
+ },
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroup",
+ "response": [
+ {
+ "description": "the list of enabled vGPUs",
+ "name": "vgpu",
+ "response": [
+ {
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
+ },
+ {
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
+ "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": "Video RAM for this vGPU type",
+ "name": "videoram",
+ "type": "long"
+ },
+ {
+ "description": "Maximum X resolution per display",
+ "name": "maxresolutionx",
+ "type": "long"
+ },
+ {
+ "description": "Model Name of vGPU",
+ "name": "vgputype",
+ "type": "string"
+ },
+ {
+ "description": "Maximum displays per user",
+ "name": "maxheads",
+ "type": "long"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroupname",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "true if the host supports encryption",
+ "name": "encryptionsupported",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "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": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
+ "type": "long"
+ },
+ {
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
+ },
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
+ },
+ {
+ "description": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
+ },
+ {
+ "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
+ "name": "hasenoughcapacity",
+ "type": "boolean"
+ },
+ {
+ "description": "the Pod name of the host",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
+ {
+ "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": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ }
+ ]
+ },
+ {
+ "description": "Deletes a storage pool.",
+ "isasync": false,
+ "name": "deleteStoragePool",
+ "params": [
+ {
+ "description": "Storage pool id",
+ "length": 255,
+ "name": "id",
+ "related": "listVsphereStoragePolicyCompatiblePools,cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)",
+ "length": 255,
+ "name": "forced",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "response": [
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "List storage pools compatible with a vSphere storage policy",
+ "isasync": false,
+ "name": "listVsphereStoragePolicyCompatiblePools",
+ "params": [
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "ID of the storage policy",
+ "length": 255,
+ "name": "policyid",
+ "related": "importVsphereStoragePolicies,listVsphereStoragePolicies",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "ID of the zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ }
+ ],
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
+ "response": [
+ {
+ "description": "the Pod ID of the storage pool",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the storage pool was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the storage pool",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool path",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "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 name of the storage pool",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "description": "the storage pool capabilities",
+ "name": "storagecapabilities",
+ "type": "map"
+ },
+ {
+ "description": "the scope of the storage pool",
+ "name": "scope",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "Whether the informed tag is a JS interpretable rule or not.",
+ "name": "istagarule",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
+ "type": "string"
+ },
+ {
+ "description": "total min IOPS currently in use by volumes",
+ "name": "allocatediops",
+ "type": "long"
+ },
+ {
+ "description": "the total disk size of the storage pool",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "storagepoolstatus"
+ },
+ {
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "Storage provider for this pool",
+ "name": "provider",
+ "type": "string"
+ },
+ {
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the storage pool type",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the tags for the storage pool",
+ "name": "tags",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the cluster for the storage pool",
+ "name": "clusterid",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Deletes an existing guest network IPv6 prefix.",
+ "isasync": true,
+ "name": "deleteGuestNetworkIpv6Prefix",
+ "params": [
+ {
+ "description": "Id of the guest network IPv6 prefix",
+ "length": 255,
+ "name": "id",
+ "related": "createGuestNetworkIpv6Prefix,listGuestNetworkIpv6Prefixes",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "response": [
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {}
+ ],
+ "since": "4.17.0.0"
+ },
+ {
+ "description": "Updates a storage pool.",
+ "isasync": false,
+ "name": "updateStoragePool",
+ "params": [
+ {
+ "description": "Change the name of the storage pool",
+ "length": 255,
+ "name": "name",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
+ "required": false,
+ "since": "4.15",
+ "type": "string"
+ },
+ {
+ "description": "Whether the informed tag is a JS interpretable rule or not.",
+ "length": 255,
+ "name": "istagarule",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the details for the storage pool",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "since": "4.19.0",
+ "type": "map"
+ },
+ {
+ "description": "comma-separated list of tags for the storage pool",
+ "length": 255,
+ "name": "tags",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the Id of the storage pool",
+ "length": 255,
+ "name": "id",
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "IOPS CloudStack can provision from this storage pool",
+ "length": 255,
+ "name": "capacityiops",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "the URL of the storage pool",
+ "length": 255,
+ "name": "url",
+ "required": false,
+ "since": "4.19.0",
+ "type": "string"
+ },
+ {
+ "description": "false to disable the pool for allocation of new volumes, true to enable it back.",
+ "length": 255,
+ "name": "enabled",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "bytes CloudStack can provision from this storage pool",
+ "length": 255,
+ "name": "capacitybytes",
+ "required": false,
+ "type": "long"
+ }
+ ],
+ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
+ "response": [
+ {
+ "description": "the host's currently used disk size",
+ "name": "disksizeused",
+ "type": "long"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the storage pool",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the name of the cluster for the storage pool",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the cluster for the storage pool",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool capabilities",
+ "name": "storagecapabilities",
+ "type": "map"
+ },
+ {},
+ {
+ "description": "total min IOPS currently in use by volumes",
+ "name": "allocatediops",
+ "type": "long"
+ },
+ {
+ "description": "Whether the informed tag is a JS interpretable rule or not.",
+ "name": "istagarule",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "true if this pool is suitable to migrate a volume, false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool type",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "storagepoolstatus"
+ },
+ {},
+ {
+ "description": "the IP address of the storage pool",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the storage pool",
+ "name": "id",
+ "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 total disk size of the storage pool",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the tags for the storage pool",
+ "name": "tags",
+ "type": "string"
+ },
+ {
+ "description": "the overprovisionfactor for the storage pool",
+ "name": "overprovisionfactor",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID of the storage pool",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the scope of the storage pool",
+ "name": "scope",
+ "type": "string"
+ },
+ {
+ "description": "the storage pool path",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the storage pool",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor type of the storage pool",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name of the storage pool",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "Storage provider for this pool",
+ "name": "provider",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the storage pool",
+ "name": "zoneid",
+ "type": "string"
+ }
+ ],
+ "since": "3.0.0"
+ },
+ {
+ "description": "Reboots a system VM.",
+ "isasync": true,
+ "name": "rebootSystemVm",
+ "params": [
+ {
+ "description": "The ID of the system virtual machine",
+ "length": 255,
+ "name": "id",
+ "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "Force reboot the system VM (System VM is Stopped and then Started)",
+ "length": 255,
+ "name": "forced",
+ "required": false,
+ "since": "4.16.0",
+ "type": "boolean"
+ }
+ ],
+ "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm",
+ "response": [
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the link local MAC address for the system vm",
+ "name": "linklocalmacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the template ID for the system VM",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "guest vlan range",
+ "name": "guestvlan",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the system VM was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the public netmask for the system VM",
+ "name": "publicnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID for the system VM",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name for the system VM",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the link local IP address for the system vm",
+ "name": "linklocalip",
+ "type": "string"
+ },
+ {
+ "description": "the network domain for the system VM",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the host ID for the system VM",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "public vlan range",
+ "name": "publicvlan",
+ "type": "list"
+ },
+ {
+ "description": "the last disconnected date of host",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the system VM",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID for the system VM",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the first DNS for the system VM",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the second DNS for the system VM",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "the link local netmask for the system vm",
+ "name": "linklocalnetmask",
+ "type": "string"
+ },
+ {
+ "description": "the system VM type",
+ "name": "systemvmtype",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the Zone name for the system VM",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the state of the system VM",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the hostname for the system VM",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the system VM",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the systemvm agent version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the system virtual machine.",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the control state of the host for the system VM",
+ "name": "hostcontrolstate",
+ "type": "string"
+ },
+ {
+ "description": "the public IP address for the system VM",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the gateway for the system VM",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the private netmask for the system VM",
+ "name": "privatenetmask",
+ "type": "string"
+ },
+ {
+ "description": "the name of the service offering of the system virtual machine.",
+ "name": "serviceofferingname",
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the private MAC address for the system VM",
+ "name": "privatemacaddress",
+ "type": "string"
+ },
+ {
+ "description": "the agent state of the system VM",
+ "name": "agentstate",
+ "type": "string"
+ },
+ {
+ "description": "the private IP address for the system VM",
+ "name": "privateip",
+ "type": "string"
+ },
+ {
+ "description": "the template name for the system VM",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the number of active console sessions for the console proxy system vm",
+ "name": "activeviewersessions",
+ "type": "integer"
+ },
+ {}
+ ]
+ },
+ {
+ "description": "Lists Tungsten-Fabric tags",
+ "isasync": false,
+ "name": "listTungstenFabricTag",
+ "params": [
+ {
+ "description": "the uuid of Tungsten-Fabric policy",
+ "length": 255,
+ "name": "policyuuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the uuid of Tungsten-Fabric application policy set",
+ "length": 255,
+ "name": "applicationpolicysetuuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the uuid of Tungsten-Fabric vm",
+ "length": 255,
+ "name": "vmuuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the uuid of Tungsten-Fabric network",
+ "length": 255,
+ "name": "networkuuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the uuid of Tungsten-Fabric tag",
+ "length": 255,
+ "name": "taguuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the uuid of Tungsten-Fabric nic",
+ "length": 255,
+ "name": "nicuuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ }
+ ],
+ "related": "createTungstenFabricTag,applyTungstenFabricTag,removeTungstenFabricTag",
+ "response": [
+ {
+ "description": "Tungsten-Fabric provider zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "Tungsten-Fabric tag type uuid",
+ "name": "uuid",
+ "type": "string"
+ },
+ {
+ "description": "Tungsten-Fabric provider zone id",
+ "name": "zoneid",
+ "type": "long"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "list Tungsten-Fabric network",
+ "name": "network",
+ "type": "list"
+ },
+ {
+ "description": "list Tungsten-Fabric nic",
+ "name": "nic",
+ "type": "list"
+ },
+ {
+ "description": "list Tungsten-Fabric vm",
+ "name": "vm",
+ "type": "list"
+ },
+ {},
+ {
+ "description": "list Tungsten-Fabric policy",
+ "name": "policy",
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "Tungsten-Fabric tag name",
+ "name": "name",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Import LDAP users",
+ "isasync": false,
+ "name": "importLdapUsers",
+ "params": [
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Creates the account under the specified role.",
+ "length": 255,
+ "name": "roleid",
+ "related": "createRole,importRole,listRoles,updateRole",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "details for account used to store specific parameters",
+ "length": 255,
+ "name": "accountdetails",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.",
+ "length": 255,
+ "name": "timezone",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "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,moveDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.",
+ "length": 255,
+ "name": "group",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin",
+ "length": 255,
+ "name": "accounttype",
+ "required": false,
+ "type": "integer"
+ }
+ ],
+ "related": "searchLdap,listLdapUsers",
+ "response": [
+ {
+ "description": "The user's username",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "The user's email",
+ "name": "email",
+ "type": "string"
+ },
+ {
+ "description": "The user's domain",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "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",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "The user's firstname",
+ "name": "firstname",
+ "type": "string"
+ },
+ {
+ "description": "The user's principle",
+ "name": "principal",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "The user's lastname",
+ "name": "lastname",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
+ ],
+ "since": "4.3.0"
+ },
+ {
+ "description": "Moves a domain and its children to a new parent domain.",
+ "isasync": false,
+ "name": "moveDomain",
+ "params": [
+ {
+ "description": "The ID of the new parent domain of the domain to be moved.",
+ "length": 255,
+ "name": "parentdomainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "The ID of the domain to be moved.",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "response": [
+ {
+ "description": "the total number of snapshots stored by this domain",
+ "name": "snapshottotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of templates which can be created by this domain",
+ "name": "templatelimit",
+ "type": "string"
+ },
+ {
+ "description": "the state of the domain",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks owned by domain",
+ "name": "networktotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of vpcs available to be created for this domain",
+ "name": "vpcavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total memory (in MB) owned by domain",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the total primary storage space (in GiB) available to be used for this domain",
+ "name": "primarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) the domain can own",
+ "name": "secondarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the level of the domain",
+ "name": "level",
+ "type": "integer"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) owned by domain",
+ "name": "secondarystoragetotal",
+ "type": "float"
+ },
+ {
+ "description": "the total number of virtual machines available for this domain to acquire",
+ "name": "vmavailable",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the parent domain",
+ "name": "parentdomainid",
+ "type": "string"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses available for this domain to acquire",
+ "name": "ipavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots which can be stored by this domain",
+ "name": "snapshotlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of projects being administrated by this domain",
+ "name": "projecttotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of public ip addresses allocated for this domain",
+ "name": "iptotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of vpcs the domain can own",
+ "name": "vpclimit",
+ "type": "string"
+ },
+ {},
+ {},
+ {
+ "description": "the total number of projects available for administration by this domain",
+ "name": "projectavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of cpu cores the domain can own",
+ "name": "cpulimit",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the total memory (in MB) the domain can own",
+ "name": "memorylimit",
+ "type": "string"
+ },
+ {
+ "description": "the total secondary storage space (in GiB) available to be used for this domain",
+ "name": "secondarystorageavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total primary storage space (in GiB) owned by domain",
+ "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 virtual machines deployed by this domain",
+ "name": "vmtotal",
+ "type": "long"
+ },
+ {
+ "description": "the total volume which can be used by this domain",
+ "name": "volumelimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of public ip addresses this domain can acquire",
+ "name": "iplimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates available to be created by this domain",
+ "name": "templateavailable",
+ "type": "string"
+ },
+ {
+ "description": "the date when this domain was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "the total primary storage space (in GiB) the domain can own",
+ "name": "primarystoragelimit",
+ "type": "string"
+ },
+ {
+ "description": "the name of the domain",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the total number of snapshots available for this domain",
+ "name": "snapshotavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total number of networks available to be created for this domain",
+ "name": "networkavailable",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the total volume being used by this domain",
+ "name": "volumetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of vpcs owned by domain",
+ "name": "vpctotal",
+ "type": "long"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the total number of cpu cores owned by domain",
+ "name": "cputotal",
+ "type": "long"
+ },
+ {
+ "description": "the total memory (in MB) available to be created for this domain",
+ "name": "memoryavailable",
+ "type": "string"
+ },
+ {
+ "description": "whether the domain has one or more sub-domains",
+ "name": "haschild",
+ "type": "boolean"
+ },
+ {
+ "description": "the total number of projects the domain can own",
+ "name": "projectlimit",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the parent domain",
+ "name": "parentdomainname",
+ "type": "string"
+ },
+ {
+ "description": "the path of the domain",
+ "name": "path",
+ "type": "string"
+ },
+ {
+ "description": "the total number of virtual machines that can be deployed by this domain",
+ "name": "vmlimit",
+ "type": "string"
+ },
+ {
+ "description": "the total number of templates which have been created by this domain",
+ "name": "templatetotal",
+ "type": "long"
+ },
+ {
+ "description": "the total number of cpu cores available to be created for this domain",
+ "name": "cpuavailable",
+ "type": "string"
+ },
+ {
+ "description": "the total volume available for this domain",
+ "name": "volumeavailable",
+ "type": "string"
+ },
+ {
+ "description": "details for the domain",
+ "name": "domaindetails",
+ "type": "map"
+ },
+ {
+ "description": "the total number of networks the domain can own",
+ "name": "networklimit",
+ "type": "string"
+ }
+ ],
+ "since": "4.19.0.0"
+ },
+ {
+ "description": "Lists all available networks.",
+ "isasync": false,
+ "name": "listNetworks",
+ "params": [
+ {
+ "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter",
+ "length": 255,
+ "name": "displaynetwork",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ },
+ {
+ "description": "List networks by VPC",
+ "length": 255,
+ "name": "vpcid",
+ "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list networks by physical network id",
+ "length": 255,
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list networks by ID",
+ "length": 255,
+ "name": "id",
+ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "true if network is system, false otherwise",
+ "length": 255,
+ "name": "issystem",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID or VID of the network",
+ "length": 255,
+ "name": "vlan",
+ "required": false,
+ "since": "4.17.0",
+ "type": "string"
+ },
+ {
+ "description": "makes the API's response contains only the resource count",
+ "length": 255,
+ "name": "retrieveonlyresourcecount",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "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": "the type of the network. Supported values are: isolated, l2, shared and all",
+ "length": 255,
+ "name": "type",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list objects by project; if projectid=-1 lists All VMs",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "type of the traffic",
+ "length": 255,
+ "name": "traffictype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the network belongs to VPC",
+ "length": 255,
+ "name": "forvpc",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the zone ID of the network",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list networks supporting certain services",
+ "length": 255,
+ "name": "supportedservices",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "list networks by ACL (access control list) type. Supported values are account and domain",
+ "length": 255,
+ "name": "acltype",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by [...]
+ "length": 255,
+ "name": "networkfilter",
+ "required": false,
+ "since": "4.17.0",
+ "type": "string"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list networks by network offering ID",
+ "length": 255,
+ "name": "networkofferingid",
+ "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list networks available for VM deployment",
+ "length": 255,
+ "name": "canusefordeploy",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "flag to display the resource icon for networks",
+ "length": 255,
+ "name": "showicon",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "list networks by restartRequired",
+ "length": 255,
+ "name": "restartrequired",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "true if need to list only networks which support specifying IP ranges",
+ "length": 255,
+ "name": "specifyipranges",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "List networks by associated networks. Only available if create a Shared network.",
+ "length": 255,
+ "name": "associatednetworkid",
+ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "required": false,
+ "since": "4.17.0",
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "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.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks",
+ "response": [
+ {
+ "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE",
+ "name": "networkcidr",
+ "type": "string"
+ },
+ {
+ "description": "the id of the network",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "ACL name associated with the VPC network",
+ "name": "aclname",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the network owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "The external id of the network",
+ "name": "externalid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "true if network offering is ip conserve mode enabled",
+ "name": "networkofferingconservemode",
+ "type": "boolean"
+ },
+ {
+ "description": "if network offering supports vm autoscaling feature",
+ "name": "supportsvmautoscaling",
+ "type": "boolean"
+ },
+ {
+ "description": "availability of the network offering the network is created from",
+ "name": "networkofferingavailability",
+ "type": "string"
+ },
+ {
+ "description": "the first IPv6 DNS for the network",
+ "name": "ip6dns1",
+ "type": "string"
+ },
+ {
+ "description": "the owner of the network",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "an optional field, whether to the display the network to the end user or not.",
+ "name": "displaynetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "the network domain",
+ "name": "networkdomain",
+ "type": "string"
+ },
+ {
+ "description": "the date this network was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if users from subdomains can access the domain level network",
+ "name": "subdomainaccess",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the zone the network belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "network offering id the network is created from",
+ "name": "networkofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "The vlan of the network. This parameter is visible to ROOT admins only",
+ "name": "vlan",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Network associated with this network",
+ "name": "associatednetwork",
+ "type": "string"
+ },
+ {
+ "description": "Name of the VPC to which this network belongs",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Network associated with this private gateway",
+ "name": "associatednetwork",
+ "type": "string"
+ },
+ {
+ "description": "The routes for the network to ease adding route in upstream router",
+ "name": "ip6routes",
+ "type": "set"
+ },
+ {
+ "description": "true if network is system, false otherwise",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "the traffic type of the network",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "ACL Id associated with the VPC network",
+ "name": "aclid",
+ "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 project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the details of the network",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "acl type - access type to the network",
+ "name": "acltype",
+ "type": "string"
+ },
+ {
+ "description": "the second IPv4 DNS for the network",
+ "name": "dns2",
+ "type": "string"
+ },
+ {
+ "description": "true if network can span multiple zones",
+ "name": "strechedl2subnet",
+ "type": "boolean"
+ },
+ {
+ "description": "Tungsten-Fabric virtual router the network belongs to",
+ "name": "tungstenvirtualrouteruuid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the type of the network",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Network associated with this network",
+ "name": "associatednetworkid",
+ "type": "string"
+ },
+ {
+ "description": "state of the network",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the second IPv6 DNS for the network",
+ "name": "ip6dns2",
+ "type": "string"
+ },
+ {
+ "description": "related to what other network configuration",
+ "name": "related",
+ "type": "string"
+ },
+ {
+ "description": "true if guest network default egress policy is allow; false if default egress policy is deny",
+ "name": "egressdefaultpolicy",
+ "type": "boolean"
+ },
+ {
+ "description": "The internet protocol of network offering",
+ "name": "internetprotocol",
+ "type": "string"
+ },
+ {
+ "description": "zone id of the network",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "true if network is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "Broadcast domain type of the network",
+ "name": "broadcastdomaintype",
+ "type": "string"
+ },
+ {
+ "description": "the list of services",
+ "name": "service",
+ "response": [
+ {
+ "description": "the list of capabilities",
+ "name": "capability",
+ "response": [
+ {
+ "description": "the capability value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "can this service capability value can be choosable while creatine network offerings",
+ "name": "canchooseservicecapability",
+ "type": "boolean"
+ },
+ {
+ "description": "the capability name",
+ "name": "name",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the service provider name",
+ "name": "provider",
+ "response": [
+ {
+ "description": "true if individual services can be enabled/disabled",
+ "name": "canenableindividualservice",
+ "type": "boolean"
+ },
+ {
+ "description": "the destination physical network",
+ "name": "destinationphysicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "state of the network provider",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "uuid of the network provider",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "services for this provider",
+ "name": "servicelist",
+ "type": "list"
+ },
+ {
+ "description": "the provider name",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the service name",
+ "name": "name",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the network's netmask",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "list networks that are persistent",
+ "name": "ispersistent",
+ "type": "boolean"
+ },
+ {
+ "description": "the list of resource tags associated with network",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "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": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "MTU configured on the network VR's public facing interfaces",
+ "name": "publicmtu",
+ "type": "integer"
+ },
+ {
+ "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR",
+ "name": "cidr",
+ "type": "string"
+ },
+ {
+ "description": "name of the network offering the network is created from",
+ "name": "networkofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Network associated with this private gateway",
+ "name": "associatednetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the first IPv4 DNS for the network",
+ "name": "dns1",
+ "type": "string"
+ },
+ {
+ "description": "the physical network id",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "If the network has redundant routers enabled",
+ "name": "redundantrouter",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "VPC the network belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the name of the network",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "display text of the network offering the network is created from",
+ "name": "networkofferingdisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "The routing mode of network offering",
+ "name": "ip6routing",
+ "type": "string"
+ },
+ {
+ "description": "the domain id of the network owner",
+ "name": "domainid",
+ "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": "the network's gateway",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "MTU configured on the network VR's private interfaces",
+ "name": "privatemtu",
+ "type": "integer"
+ },
+ {
+ "description": "broadcast uri of the network. This parameter is visible to ROOT admins only",
+ "name": "broadcasturi",
+ "type": "string"
+ },
+ {
+ "description": "path of the Domain the network belongs to",
+ "name": "domainpath",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "true if network supports specifying ip ranges, false otherwise",
+ "name": "specifyipranges",
+ "type": "boolean"
+ },
+ {
+ "description": "the displaytext of the network",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "true network requires restart",
+ "name": "restartrequired",
+ "type": "boolean"
+ },
+ {
+ "description": "list networks available for vm deployment",
+ "name": "canusefordeploy",
+ "type": "boolean"
+ }
+ ]
+ },
+ {
+ "description": "List dedicated zones.",
+ "isasync": false,
+ "name": "listDedicatedZones",
+ "params": [
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the Zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "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": "the ID of the domain associated with the zone",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list dedicated zones by affinity group",
+ "length": 255,
+ "name": "affinitygroupid",
+ "related": "createAffinityGroup,listAffinityGroups",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ }
+ ],
+ "related": "dedicateZone",
+ "response": [
+ {
+ "description": "the Account Id to which the Zone is dedicated",
+ "name": "accountid",
+ "type": "string"
+ },
+ {
+ "description": "the Name of the Zone",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Zone",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID to which the Zone is dedicated",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the dedicated resource",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the Dedication Affinity Group ID of the zone",
+ "name": "affinitygroupid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
+ ]
+ },
+ {
+ "description": "Lists the pools of elastistor",
+ "isasync": false,
+ "name": "listElastistorPool",
+ "params": [
+ {
+ "description": "the ID of the Pool",
+ "length": 255,
+ "name": "id",
+ "required": false,
+ "type": "long"
+ }
+ ],
+ "related": "",
+ "response": [
+ {
+ "description": "the name of the storage pool",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "available iops of the pool",
+ "name": "maxiops",
+ "type": "long"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the current available space of the pool",
+ "name": "size",
+ "type": "long"
+ },
+ {
+ "description": "controller of the pool",
+ "name": "controllerid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the ID of the storage pool",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the state of the storage pool",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "default gateway of the pool",
+ "name": "gateway",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Releases an IP address from the account.",
+ "isasync": false,
+ "name": "releaseIpAddress",
+ "params": [
+ {
+ "description": "the ID of the public IP address to release",
+ "length": 255,
+ "name": "id",
+ "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "response": [
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {},
+ {},
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
+ ],
+ "since": "4.17"
+ },
+ {
+ "description": "Updates a management network IP range. Only allowed when no IPs are allocated.",
+ "isasync": true,
+ "name": "updatePodManagementNetworkIpRange",
+ "params": [
+ {
+ "description": "The new ending IP address.",
+ "length": 255,
+ "name": "newendip",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "The current starting IP address.",
+ "length": 255,
+ "name": "currentstartip",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "The new starting IP address.",
+ "length": 255,
+ "name": "newstartip",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "UUID of POD, where the IP range belongs to.",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "The current ending IP address.",
+ "length": 255,
+ "name": "currentendip",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "response": [
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
+ ],
+ "since": "4.16.0.0"
+ },
+ {
+ "description": "list Tungsten-Fabric LB health monitor",
+ "isasync": false,
+ "name": "listTungstenFabricLBHealthMonitor",
+ "params": [
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the ID of lb rule",
+ "length": 255,
+ "name": "lbruleid",
+ "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "updateTungstenFabricLBHealthMonitor",
+ "response": [
+ {
+ "description": "Tungsten-Fabric provider zone id",
+ "name": "zoneid",
+ "type": "long"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the health monitor UUID",
+ "name": "uuid",
+ "type": "string"
+ },
+ {
+ "description": "the health monitor timeout",
+ "name": "timeout",
+ "type": "int"
+ },
+ {
+ "description": "the health monitor expected code",
+ "name": "expectedcode",
+ "type": "string"
+ },
+ {
+ "description": "the LB rule ID",
+ "name": "lbruleid",
+ "type": "string"
+ },
+ {
+ "description": "Tungsten-Fabric provider zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the health monitor ID",
+ "name": "id",
+ "type": "long"
+ },
+ {
+ "description": "the health monitor retry",
+ "name": "retry",
+ "type": "int"
+ },
+ {
+ "description": "the health monitor url path",
+ "name": "urlpath",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the health monitor http method",
+ "name": "httpmethod",
+ "type": "string"
+ },
+ {
+ "description": "the health monitor interval",
+ "name": "interval",
+ "type": "int"
+ },
+ {},
+ {
+ "description": "the health monitor type",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ }
+ ]
+ },
+ {
+ "description": "Updates firewall rule ",
+ "isasync": true,
+ "name": "updateFirewallRule",
+ "params": [
+ {
+ "description": "the ID of the firewall rule",
+ "length": 255,
+ "name": "id",
+ "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
+ },
+ {
+ "description": "an optional field, whether to the display the rule to the end user or not",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ }
+ ],
+ "related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule",
+ "response": [
+ {
+ "description": "the public ip address for the firewall rule",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).",
+ "name": "cidrlist",
+ "type": "string"
+ },
+ {
+ "description": "the starting port of firewall rule's port range",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).",
+ "name": "destcidrlist",
+ "type": "string"
+ },
+ {
+ "description": "the state of the rule",
+ "name": "state",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the firewall rule",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "error code for this icmp message",
+ "name": "icmpcode",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "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"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "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"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "type of the icmp message being sent",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the ending port of firewall rule's port range",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the traffic type for the firewall rule",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the firewall rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "is rule for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the public ip address id for the firewall rule",
+ "name": "ipaddressid",
+ "type": "string"
+ },
+ {
+ "description": "the network id of the firewall rule",
+ "name": "networkid",
+ "type": "string"
+ }
+ ],
+ "since": "4.4"
+ },
+ {
+ "description": "Return true if the plugin is enabled",
+ "isasync": false,
+ "name": "quotaIsEnabled",
+ "params": [],
+ "related": "",
+ "response": [
+ {},
+ {},
+ {
+ "description": "is quota service enabled",
+ "name": "isenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
+ ],
+ "since": "4.7.0"
+ },
+ {
+ "description": "Deletes the registered OAuth provider",
+ "isasync": false,
+ "name": "deleteOauthProvider",
+ "params": [
+ {
+ "description": "id of the OAuth provider to be deleted",
+ "length": 255,
+ "name": "id",
+ "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "response": [
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
+ ],
+ "since": "4.19.0"
+ },
+ {
+ "description": "Deletes account from the project",
+ "isasync": true,
+ "name": "deleteAccountFromProject",
+ "params": [
+ {
+ "description": "ID of the project to remove the account from",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "name of the account to be removed from the project",
+ "length": 255,
+ "name": "account",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "response": [
+ {
+ "description": "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"
+ }
+ ],
+ "since": "3.0.0"
+ },
+ {
+ "description": "List hypervisors",
+ "isasync": false,
+ "name": "listHypervisors",
+ "params": [
+ {
+ "description": "the zone id for listing hypervisors.",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ }
+ ],
+ "related": "",
+ "response": [
+ {
+ "description": "Hypervisor name",
+ "name": "name",
+ "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": "Updates the information about Guest OS",
+ "isasync": true,
+ "name": "updateGuestOs",
+ "params": [
+ {
+ "description": "Unique display name for Guest OS",
+ "length": 255,
+ "name": "osdisplayname",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "UUID of the Guest OS",
+ "length": 255,
+ "name": "id",
+ "related": "listOsTypes,addGuestOs,updateGuestOs",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "Map of (key/value pairs)",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "type": "map"
+ },
+ {
+ "description": "whether this guest OS is available for end users",
+ "length": 255,
+ "name": "forDisplay",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "related": "listOsTypes,addGuestOs",
+ "response": [
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "is the guest OS visible for the users",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "the ID of the OS type",
+ "name": "id",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the ID of the OS category",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the OS category",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {
+ "description": "the name of the OS type",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the name/description of the OS type",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "is the guest OS user defined",
+ "name": "isuserdefined",
+ "type": "boolean"
+ }
+ ],
+ "since": "4.4.0"
+ },
+ {
+ "description": "Lists all guest vlans",
+ "isasync": false,
+ "name": "listGuestVlans",
+ "params": [
+ {
+ "description": "list guest vlan by vnet",
+ "length": 255,
+ "name": "vnet",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list guest vlan by id",
+ "length": 255,
+ "name": "id",
+ "required": false,
+ "type": "long"
+ },
+ {
+ "description": "list guest vlan by physical network",
+ "length": 255,
+ "name": "physicalnetworkid",
+ "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "list guest vlan by zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "limits search results to allocated guest vlan. false by default.",
+ "length": 255,
+ "name": "allocatedonly",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "related": "",
+ "response": [
+ {
+ "description": "the guest VLAN",
+ "name": "vlan",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project name of the guest VLAN range",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the zone name of the guest VLAN range",
+ "name": "zonename",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the account of the guest VLAN range",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the guest VLAN range",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the physical network name of the guest VLAN range",
+ "name": "physicalnetworkname",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the guest VLAN range",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the physical network ID of the guest VLAN range",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the guest VLAN id",
+ "name": "id",
+ "type": "long"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the zone ID of the guest VLAN range",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the guest VLAN range",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the list of networks who use this guest VLAN",
+ "name": "network",
+ "type": "list"
+ },
+ {
+ "description": "the allocation state of the guest VLAN",
+ "name": "allocationstate",
+ "type": "string"
+ },
+ {
+ "description": "true if the guest VLAN is dedicated to the account",
+ "name": "isdedicated",
+ "type": "boolean"
+ },
+ {
+ "description": "date the guest VLAN was taken",
+ "name": "taken",
+ "type": "date"
+ }
+ ],
+ "since": "4.17.0"
+ },
+ {
+ "description": "Updates resource limits for an account or domain.",
+ "isasync": false,
+ "name": "updateResourceLimit",
+ "params": [
+ {
+ "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": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Update resource limits for project",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "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 for a specified account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": " Maximum resource limit.",
+ "length": 255,
+ "name": "max",
+ "required": false,
+ "type": "long"
+ }
+ ],
+ "related": "listResourceLimits",
+ "response": [
+ {
+ "description": "the project name of the resource limit",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account of the resource limit",
+ "name": "account",
+ "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 UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the resource limit",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.",
+ "name": "resourcetypename",
+ "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 current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the project id of the resource limit",
+ "name": "projectid",
+ "type": "string"
+ },
+ {}
+ ]
+ },
+ {
+ "description": "Deletes a static route",
+ "isasync": true,
+ "name": "deleteStaticRoute",
+ "params": [
+ {
+ "description": "the ID of the static route",
+ "length": 255,
+ "name": "id",
+ "related": "createStaticRoute,listStaticRoutes",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "response": [
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Lists hosts metrics",
+ "isasync": false,
+ "name": "listHostsMetrics",
+ "params": [
+ {
+ "description": "the state of the host",
+ "length": 255,
+ "name": "state",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID for the host",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "lists hosts existing in particular cluster",
+ "length": 255,
+ "name": "clusterid",
+ "related": "addCluster,listClusters,updateCluster",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the Pod ID for the host",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list hosts for which out-of-band management is enabled",
+ "length": 255,
+ "name": "outofbandmanagementenabled",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "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",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtua [...]
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the id of the host",
+ "length": 255,
+ "name": "id",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "if true, list only hosts dedicated to HA",
+ "length": 255,
+ "name": "hahost",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]",
+ "length": 255,
+ "name": "details",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the name of the host",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "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"
+ },
+ {
+ "description": "the host type",
+ "length": 255,
+ "name": "type",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "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": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator",
+ "length": 255,
+ "name": "hypervisor",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "related": "",
+ "response": [
+ {
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the total memory allocated in GiB",
+ "name": "memoryallocatedgb",
+ "type": "string"
+ },
+ {
+ "description": "cpu allocated notification threshold exceeded",
+ "name": "cpuallocatedthreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "Whether the informed tag is a JS interpretable rule or not.",
+ "name": "istagarule",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the total memory capacity in GiB",
+ "name": "memorytotalgb",
+ "type": "string"
+ },
+ {
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
+ },
+ {
+ "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": "cpu usage notification threshold exceeded",
+ "name": "cputhreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the host supports encryption",
+ "name": "encryptionsupported",
+ "type": "boolean"
+ },
+ {
+ "description": "cpu usage disable threshold exceeded",
+ "name": "cpudisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the total cpu allocated in Ghz",
+ "name": "cpuallocatedghz",
+ "type": "string"
+ },
+ {
+ "description": "network write in GiB",
+ "name": "networkwrite",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "memory allocated disable threshold exceeded",
+ "name": "memoryallocateddisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "memory usage disable threshold exceeded",
+ "name": "memorydisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
+ },
+ {
+ "description": "memory usage notification threshold exceeded",
+ "name": "memorythreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "memory allocated notification threshold exceeded",
+ "name": "memoryallocatedthreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "type": "string"
+ },
+ {
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "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 total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "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": "the total memory used in GiB",
+ "name": "memoryusedgb",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
+ "description": "the total cpu capacity in Ghz",
+ "name": "cputotalghz",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the Pod name of the host",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "network read in GiB",
+ "name": "networkread",
+ "type": "string"
+ },
+ {
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "instances on the host",
+ "name": "instances",
+ "type": "string"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "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 last annotation set on this host by an admin",
+ "name": "annotation",
+ "type": "string"
+ },
+ {
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "out-of-band management power state",
+ "name": "powerstate",
+ "type": "powerstate"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the average cpu load the last minute",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
+ },
+ {
+ "description": "the total cpu used in Ghz",
+ "name": "cpuusedghz",
+ "type": "string"
+ },
+ {
+ "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 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": "Maximum displays per user",
+ "name": "maxheads",
+ "type": "long"
+ },
+ {
+ "description": "Model Name of vGPU",
+ "name": "vgputype",
+ "type": "string"
+ },
+ {
+ "description": "Maximum X resolution per display",
+ "name": "maxresolutionx",
+ "type": "long"
+ },
+ {
+ "description": "Video RAM for this vGPU type",
+ "name": "videoram",
+ "type": "long"
+ },
+ {
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
+ "type": "long"
+ },
+ {
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "type": "long"
+ }
+ ],
+ "type": "list"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
+ },
+ {
+ "description": "system vm instances on the host",
+ "name": "systeminstances",
+ "type": "string"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
+ },
+ {
+ "description": "cpu allocated disable threshold exceeded",
+ "name": "cpuallocateddisablethreshold",
+ "type": "boolean"
+ },
+ {
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
+ "type": "string"
+ }
+ ],
+ "since": "4.9.3"
+ },
+ {
+ "description": "get load balancer certificate",
+ "isasync": false,
+ "name": "getLoadBalancerSslCertificate",
+ "params": [
+ {
+ "description": "the ID of Lb",
+ "length": 255,
+ "name": "id",
+ "related": "getLoadBalancerSslCertificate",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "",
+ "response": [
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {},
+ {
+ "description": "key",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "chain",
+ "name": "chain",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "crt",
+ "name": "crt",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Release the dedication for the pod",
+ "isasync": true,
+ "name": "releaseDedicatedPod",
+ "params": [
+ {
+ "description": "the ID of the Pod",
+ "length": 255,
+ "name": "podid",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "response": [
+ {
+ "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"
+ }
+ ]
+ },
+ {
+ "description": "Lists affinity groups",
+ "isasync": false,
+ "name": "listAffinityGroups",
+ "params": [
+ {
+ "description": "lists affinity groups by name",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "lists affinity groups by virtual machine ID",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtua [...]
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.",
+ "length": 255,
+ "name": "listall",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list resources by account. Must be used with the domainId parameter.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list the affinity group by the ID provided",
+ "length": 255,
+ "name": "id",
+ "related": "createAffinityGroup,listAffinityGroups",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "list objects by project; if projectid=-1 lists All VMs",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "lists affinity groups by type",
+ "length": 255,
+ "name": "type",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "list only resources belonging to the domain specified",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ }
+ ],
+ "related": "createAffinityGroup",
+ "response": [
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {}
+ ]
+ },
+ {
+ "description": "Cancels a triggered shutdown",
+ "isasync": false,
+ "name": "cancelShutdown",
+ "params": [
+ {
+ "description": "the uuid of the management server",
+ "length": 255,
+ "name": "managementserverid",
+ "related": "listManagementServers",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "prepareForShutdown,readyForShutdown,triggerShutdown",
+ "response": [
+ {
+ "description": "Indicates whether a shutdown has been triggered",
+ "name": "shutdowntriggered",
+ "type": "boolean"
+ },
+ {},
+ {},
+ {
+ "description": "The number of jobs in progress",
+ "name": "pendingjobscount",
+ "type": "long"
+ },
+ {
+ "description": "The id of the management server",
+ "name": "managementserverid",
+ "type": "long"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "Indicates whether CloudStack is ready to shutdown",
+ "name": "readyforshutdown",
+ "type": "boolean"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
+ ],
+ "since": "4.19.0"
+ },
+ {
+ "description": "Register a public key in a keypair under a certain name",
+ "isasync": false,
+ "name": "registerSSHKeyPair",
+ "params": [
+ {
+ "description": "Public key material of the keypair",
+ "length": 5120,
+ "name": "publickey",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "Name of the keypair",
+ "length": 255,
+ "name": "name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "description": "an optional account for the ssh key. Must be used with domainId.",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "an optional project for the ssh key",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "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": "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 domain id of the keypair owner",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the owner of the keypair",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the keypair owner",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the keypair owner",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "ID of the ssh keypair",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "Fingerprint of the public key",
+ "name": "fingerprint",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project id of the keypair owner",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "Name of the keypair",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ }
+ ]
+ },
+ {
+ "description": "Destroys a l2tp/ipsec remote access vpn",
+ "isasync": true,
+ "name": "deleteRemoteAccessVpn",
+ "params": [
+ {
+ "description": "public ip address id of the vpn server",
+ "length": 255,
+ "name": "publicipid",
+ "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "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",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {}
+ ]
+ },
+ {
+ "description": "Start rolling maintenance",
+ "isasync": true,
+ "name": "startRollingMaintenance",
+ "params": [
+ {
+ "description": "the IDs of the hosts to start maintenance on",
+ "length": 255,
+ "name": "hostids",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "if rolling mechanism should continue in case of an error",
+ "length": 255,
+ "name": "forced",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "optional operation timeout (in seconds) that overrides the global timeout setting",
+ "length": 255,
+ "name": "timeout",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "the IDs of the clusters to start maintenance on",
+ "length": 255,
+ "name": "clusterids",
+ "related": "addCluster,listClusters,updateCluster",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the IDs of the zones to start maintenance on",
+ "length": 255,
+ "name": "zoneids",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the command to execute while hosts are on maintenance",
+ "length": 255,
+ "name": "payload",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the IDs of the pods to start maintenance on",
+ "length": 255,
+ "name": "podids",
+ "related": "listPods,updatePod,createManagementNetworkIpRange",
+ "required": false,
+ "type": "list"
+ }
+ ],
+ "related": "",
+ "response": [
+ {
+ "description": "the hosts updated",
+ "name": "hostsupdated",
+ "response": [
+ {
+ "description": "the ID of the updated host",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "output of the maintenance script on the host",
+ "name": "output",
+ "type": "string"
+ },
+ {
+ "description": "start date of the update on the host",
+ "name": "startdate",
+ "type": "string"
+ },
+ {
+ "description": "the name of the updated host",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "end date of the update on the host",
+ "name": "enddate",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "the hosts skipped",
+ "name": "hostsskipped",
+ "response": [
+ {
+ "description": "the name of the skipped host",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the skipped host",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the reason to skip the host",
+ "name": "reason",
+ "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"
+ },
+ {
+ "description": "in case of failure, details are displayed",
+ "name": "details",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "list Tungsten-Fabric application policy set",
+ "isasync": false,
+ "name": "listTungstenFabricApplicationPolicySet",
+ "params": [
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the uuid of Tungsten-Fabric application policy set",
+ "length": 255,
+ "name": "applicationpolicysetuuid",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of zone",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ }
+ ],
+ "related": "createTungstenFabricApplicationPolicySet",
+ "response": [
+ {
+ "description": "Tungsten-Fabric policy name",
+ "name": "name",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "Tungsten-Fabric provider zone id",
+ "name": "zoneid",
+ "type": "long"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "Tungsten-Fabric application policy uuid",
+ "name": "uuid",
+ "type": "string"
+ },
+ {
+ "description": "list Tungsten-Fabric firewall policy",
+ "name": "firewallpolicy",
+ "type": "list"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "list Tungsten-Fabric tag",
+ "name": "tag",
+ "type": "list"
+ },
+ {
+ "description": "Tungsten-Fabric provider zone name",
+ "name": "zonename",
+ "type": "string"
+ },
+ {}
+ ]
+ },
+ {
+ "description": "Updates network ACL list",
+ "isasync": true,
+ "name": "updateNetworkACLList",
+ "params": [
+ {
+ "description": "the ID of the network ACL",
+ "length": 255,
+ "name": "id",
+ "related": "createNetworkACLList,listNetworkACLLists",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "Name of the network ACL list",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only",
+ "length": 255,
+ "name": "customid",
+ "required": false,
+ "since": "4.4",
+ "type": "string"
+ },
+ {
+ "description": "Description of the network ACL list",
+ "length": 255,
+ "name": "description",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "an optional field, whether to the display the list to the end user or not",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "since": "4.4",
+ "type": "boolean"
+ }
+ ],
+ "response": [
+ {
+ "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"
+ },
+ {},
+ {}
+ ],
+ "since": "4.4"
+ },
+ {
+ "description": "Reserve a public IP to an account.",
+ "isasync": false,
+ "name": "reserveIpAddress",
+ "params": [
+ {
+ "description": "the ID of the domain to reserve with this IP address",
+ "length": 255,
+ "name": "domainid",
+ "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "the account to reserve with this IP address",
+ "length": 255,
+ "name": "account",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the ID of the project to reserve with this IP address",
+ "length": 255,
+ "name": "projectid",
+ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "an optional field, whether to the display the IP to the end user or not",
+ "length": 255,
+ "name": "fordisplay",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the public IP address to reserve",
+ "length": 255,
+ "name": "id",
+ "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses",
+ "response": [
+ {
+ "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)",
+ "name": "issystem",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the Network associated with the IP address",
+ "name": "associatednetworkname",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine id the ip address is assigned to",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the ipaddress",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the zone the public IP address belongs to",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the physical network this belongs to",
+ "name": "physicalnetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the Network where ip belongs to",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "date the public IP address was acquired",
+ "name": "allocated",
+ "type": "date"
+ },
+ {
+ "description": "public IP address id",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the project name of the address",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the Network associated with the IP address",
+ "name": "associatednetworkid",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the domain the public IP address is associated with",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine (dnat) ip address (not null only for static nat Ip)",
+ "name": "vmipaddress",
+ "type": "string"
+ },
+ {
+ "description": "VPC name the ip belongs to",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "true if this ip is for static nat, false otherwise",
+ "name": "isstaticnat",
+ "type": "boolean"
+ },
+ {
+ "description": "the ID of the Network where ip belongs to",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the virtual network for the IP address",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined",
+ "name": "hasrules",
+ "type": "boolean"
+ },
+ {
+ "description": "public IP address",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the VLAN associated with the IP address",
+ "name": "vlanname",
+ "type": "string"
+ },
+ {
+ "description": "is public IP portable across the zones",
+ "name": "isportable",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the zone the public IP address belongs to",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the account the public IP address is associated with",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)",
+ "name": "virtualmachinedisplayname",
+ "type": "string"
+ },
+ {
+ "description": "is public ip for display to the regular user",
+ "name": "fordisplay",
+ "type": "boolean"
+ },
+ {
+ "description": "the list of resource tags associated with ip address",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "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 ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {},
+ {
+ "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only",
+ "name": "vlanid",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine type the ip address is assigned to",
+ "name": "virtualmachinetype",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine name the ip address is assigned to",
+ "name": "virtualmachinename",
+ "type": "string"
+ },
+ {
+ "description": "VPC id the ip belongs to",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value",
+ "name": "purpose",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID the public IP address is associated with",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "true if the IP address is a source nat address, false otherwise",
+ "name": "issourcenat",
+ "type": "boolean"
+ },
+ {
+ "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free",
+ "name": "state",
+ "type": "string"
+ }
+ ],
+ "since": "4.17"
+ },
+ {
+ "description": "Restore a VM to original template/ISO or new template/ISO",
+ "isasync": true,
+ "name": "restoreVirtualMachine",
+ "params": [
+ {
+ "description": "Virtual Machine ID",
+ "length": 255,
+ "name": "virtualmachineid",
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtua [...]
+ "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,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
+ "required": false,
+ "type": "uuid"
+ }
+ ],
+ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForV [...]
+ "response": [
+ {
+ "description": "the name of the host for the virtual machine",
+ "name": "hostname",
+ "type": "string"
+ },
+ {
+ "description": " an alternate display text of the template for the virtual machine",
+ "name": "templatedisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "Guest vm Boot Type",
+ "name": "boottype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the backup offering of the virtual machine",
+ "name": "backupofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the name of userdata used for the VM",
+ "name": "userdataname",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the hypervisor on which the template runs",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the user's name who deployed the virtual machine",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the control state of the host for the virtual machine",
+ "name": "hostcontrolstate",
+ "type": "string"
+ },
+ {
+ "description": "an optional field whether to the display the vm to the end user or not.",
+ "name": "displayvm",
+ "type": "boolean"
+ },
+ {
+ "description": "the date when this virtual machine was updated last time",
+ "name": "lastupdated",
+ "type": "date"
+ },
+ {
+ "description": "list of security groups associated with the virtual machine",
+ "name": "securitygroup",
+ "response": [
+ {
+ "description": "the domain name of the security group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the description of the security group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the security group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the name of the security group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "the domain ID of the security group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the list of resource tags associated with the rule",
+ "name": "tags",
+ "response": [
+ {
+ "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 domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "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 name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the number of virtualmachines associated with this securitygroup",
+ "name": "virtualmachinecount",
+ "type": "integer"
+ },
+ {
+ "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 protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "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 starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "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": "customer associated with the tag",
+ "name": "customer",
+ "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": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the ending IP of the security group rule ",
+ "name": "endport",
+ "type": "integer"
+ },
+ {
+ "description": "the type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "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 type of the ICMP message response",
+ "name": "icmptype",
+ "type": "integer"
+ },
+ {
+ "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": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "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": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the starting IP of the security group rule",
+ "name": "startport",
+ "type": "integer"
+ },
+ {
+ "description": "the id of the security group rule",
+ "name": "ruleid",
+ "type": "string"
+ },
+ {
+ "description": "the protocol of the security group rule",
+ "name": "protocol",
+ "type": "string"
+ },
+ {
+ "description": "security group name",
+ "name": "securitygroupname",
+ "type": "string"
+ },
+ {
+ "description": "account owning the security group rule",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the CIDR notation for the base IP address of the security group rule",
+ "name": "cidr",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the project name of the group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the list of virtualmachine ids associated with this securitygroup",
+ "name": "virtualmachineids",
+ "type": "set"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the target memory in VM (KiB)",
+ "name": "memorytargetkbs",
+ "type": "long"
+ },
+ {
+ "description": "OS type id of the vm",
+ "name": "ostypeid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the virtual machine",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "true if the password rest feature is enabled, false otherwise",
+ "name": "passwordenabled",
+ "type": "boolean"
+ },
+ {
+ "description": "the list of resource tags associated",
+ "name": "tags",
+ "response": [
+ {
+ "description": "the project name where tag belongs to",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the tag",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the domain associated with the tag",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "resource type",
+ "name": "resourcetype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the domain associated with the tag",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "tag value",
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "description": "the project id the tag belongs to",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "tag key name",
+ "name": "key",
+ "type": "string"
+ },
+ {
+ "description": "id of the resource",
+ "name": "resourceid",
+ "type": "string"
+ },
+ {
+ "description": "customer associated with the tag",
+ "name": "customer",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the read (IO) of disk on the VM",
+ "name": "diskioread",
+ "type": "long"
+ },
+ {
+ "description": "the id of userdata used for the VM",
+ "name": "userdataid",
+ "type": "string"
+ },
+ {
+ "description": "the vGPU type used by the virtual machine",
+ "name": "vgpu",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the list of nics associated with vm",
+ "name": "nic",
+ "response": [
+ {
+ "description": "device id for the network when plugged into the virtual machine",
+ "name": "deviceid",
+ "type": "string"
+ },
+ {
+ "description": "the cidr of IPv6 network",
+ "name": "ip6cidr",
+ "type": "string"
+ },
+ {
+ "description": "the name of the corresponding network",
+ "name": "networkname",
+ "type": "string"
+ },
+ {
+ "description": "MTU configured on the NIC",
+ "name": "mtu",
+ "type": "integer"
+ },
+ {
+ "description": "public IP address id associated with this nic via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {
+ "description": "the Secondary ipv4 addr of nic",
+ "name": "secondaryip",
+ "type": "list"
+ },
+ {
+ "description": "the traffic type of the nic",
+ "name": "traffictype",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vpc to which the nic belongs",
+ "name": "vpcid",
+ "type": "string"
+ },
+ {
+ "description": "Id of the vm to which the nic belongs",
+ "name": "virtualmachineid",
+ "type": "string"
+ },
+ {
+ "description": "the type of the nic",
+ "name": "type",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN if available",
+ "name": "isolatedpvlan",
+ "type": "integer"
+ },
+ {
+ "description": "name of the vpc to which the nic belongs",
+ "name": "vpcname",
+ "type": "string"
+ },
+ {
+ "description": "the extra dhcp options on the nic",
+ "name": "extradhcpoption",
+ "type": "list"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "isdefault",
+ "type": "boolean"
+ },
+ {
+ "description": "the IPv6 address of network",
+ "name": "ip6address",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise",
+ "name": "nsxlogicalswitchport",
+ "type": "string"
+ },
+ {
+ "description": "true if nic is default, false otherwise",
+ "name": "macaddress",
+ "type": "string"
+ },
+ {
+ "description": "Type of adapter if available",
+ "name": "adaptertype",
+ "type": "string"
+ },
+ {
+ "description": "Id of the NSX Logical Switch (if NSX based), null otherwise",
+ "name": "nsxlogicalswitch",
+ "type": "string"
+ },
+ {
+ "description": "the broadcast uri of the nic",
+ "name": "broadcasturi",
+ "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 ID of the corresponding network",
+ "name": "networkid",
+ "type": "string"
+ },
+ {
+ "description": "public IP address associated with this nic via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the ip address of the nic",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the netmask of the nic",
+ "name": "netmask",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of IPv6 network",
+ "name": "ip6gateway",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the nic",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the gateway of the nic",
+ "name": "gateway",
+ "type": "string"
+ },
+ {
+ "description": "the isolated private VLAN type if available",
+ "name": "isolatedpvlantype",
+ "type": "string"
+ },
+ {
+ "description": "the isolation uri of the nic",
+ "name": "isolationuri",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "Name of AutoScale VM group",
+ "name": "autoscalevmgroupname",
+ "type": "string"
+ },
+ {
+ "description": "the speed of each vCPU",
+ "name": "cpuspeed",
+ "type": "integer"
+ },
+ {
+ "description": "Base64 string representation of the resource icon",
+ "name": "icon",
+ "type": "resourceiconresponse"
+ },
+ {
+ "description": "the state of the virtual machine",
+ "name": "state",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the total number of network traffic bytes received",
+ "name": "receivedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the name of the ISO attached to the virtual machine",
+ "name": "isoname",
+ "type": "string"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicipid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the project name of the vm",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the total number of network traffic bytes sent",
+ "name": "sentbytes",
+ "type": "long"
+ },
+ {
+ "description": "the group name of the virtual machine",
+ "name": "group",
+ "type": "string"
+ },
+ {
+ "description": "the VM's disk read in KiB",
+ "name": "diskkbsread",
+ "type": "long"
+ },
+ {
+ "description": "list of affinity groups associated with the virtual machine",
+ "name": "affinitygroup",
+ "response": [
+ {
+ "description": "the domain ID of the affinity group",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the project ID of the affinity group",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "virtual machine IDs associated with this affinity group",
+ "name": "virtualmachineIds",
+ "type": "list"
+ },
+ {
+ "description": "the project name of the affinity group",
+ "name": "project",
+ "type": "string"
+ },
+ {
+ "description": "the name of the affinity group",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the affinity group",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the description of the affinity group",
+ "name": "description",
+ "type": "string"
+ },
+ {
+ "description": "the domain name of the affinity group",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the account owning the affinity group",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the type of the affinity group",
+ "name": "type",
+ "type": "string"
+ }
+ ],
+ "type": "set"
+ },
+ {
+ "description": "the ID of the availability zone for the virtual machine",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "List of read-only Vm details as comma separated string.",
+ "name": "readonlydetails",
+ "type": "string"
+ },
+ {
+ "description": "the VM's disk write in KiB",
+ "name": "diskkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "Guest vm Boot Mode",
+ "name": "bootmode",
+ "type": "string"
+ },
+ {
+ "description": "device ID of the root volume",
+ "name": "rootdeviceid",
+ "type": "long"
+ },
+ {
+ "description": "the name of the service offering of the virtual machine",
+ "name": "serviceofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the write (IO) of disk on the VM",
+ "name": "diskiowrite",
+ "type": "long"
+ },
+ {
+ "description": "ssh key-pairs",
+ "name": "keypairs",
+ "type": "string"
+ },
+ {
+ "description": "NICs of the VNF appliance",
+ "name": "vnfnics",
+ "type": "list"
+ },
+ {
+ "description": "the user's ID who deployed the virtual machine",
+ "name": "userid",
+ "type": "string"
+ },
+ {
+ "description": "OS name of the vm",
+ "name": "osdisplayname",
+ "type": "string"
+ },
+ {
+ "description": "true if high-availability is enabled, false otherwise",
+ "name": "haenable",
+ "type": "boolean"
+ },
+ {
+ "description": "the date when this virtual machine was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "ID of AutoScale VM group",
+ "name": "autoscalevmgroupid",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host for the virtual machine",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the outgoing network traffic on the host in KiB",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.",
+ "name": "templateid",
+ "type": "string"
+ },
+ {
+ "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated",
+ "name": "memoryintfreekbs",
+ "type": "long"
+ },
+ {
+ "description": "State of the Service from LB rule",
+ "name": "servicestate",
+ "type": "string"
+ },
+ {
+ "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead",
+ "name": "diskofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the incoming network traffic on the VM in KiB",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead",
+ "name": "diskofferingid",
+ "type": "string"
+ },
+ {
+ "description": "VNF details",
+ "name": "vnfdetails",
+ "type": "map"
+ },
+ {
+ "description": "public IP address id associated with vm via Static nat rule",
+ "name": "publicip",
+ "type": "string"
+ },
+ {
+ "description": "the name of the virtual machine",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "an alternate display text of the ISO attached to the virtual machine",
+ "name": "isodisplaytext",
+ "type": "string"
+ },
+ {
+ "description": "Os type ID of the virtual machine",
+ "name": "guestosid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the name of the domain in which the virtual machine exists",
+ "name": "domain",
+ "type": "string"
+ },
+ {
+ "description": "the number of vCPUs this virtual machine is using",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "device type of the root volume",
+ "name": "rootdevicetype",
+ "type": "string"
+ },
+ {
+ "description": "user generated name. The name of the virtual machine is returned if no displayname exists.",
+ "name": "displayname",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the service offering of the virtual machine",
+ "name": "serviceofferingid",
+ "type": "string"
+ },
+ {
+ "description": "the memory allocated for the virtual machine",
+ "name": "memory",
+ "type": "integer"
+ },
+ {
+ "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.",
+ "name": "isdynamicallyscalable",
+ "type": "boolean"
+ },
+ {
+ "description": "Vm details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "the ID of the domain in which the virtual machine exists",
+ "name": "domainid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the backup offering of the virtual machine",
+ "name": "backupofferingname",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "the account associated with the virtual machine",
+ "name": "account",
+ "type": "string"
+ },
+ {
+ "description": "the type of the template for the virtual machine",
+ "name": "templatetype",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the ISO attached to the virtual machine",
+ "name": "isoid",
+ "type": "string"
+ },
+ {
+ "description": "the password (if exists) of the virtual machine",
+ "name": "password",
+ "type": "string"
+ },
+ {
+ "description": "list of variables and values for the variables declared in userdata",
+ "name": "userdatadetails",
+ "type": "string"
+ },
+ {
+ "description": "the group ID of the virtual machine",
+ "name": "groupid",
+ "type": "string"
+ },
+ {
+ "description": "the name of the availability zone for the virtual machine",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the vm's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the virtual network for the service offering",
+ "name": "forvirtualnetwork",
+ "type": "boolean"
+ },
+ {
+ "description": "Base64 string containing the user data",
+ "name": "userdata",
+ "type": "string"
+ },
+ {
+ "description": "the name of the template for the virtual machine",
+ "name": "templatename",
+ "type": "string"
+ },
+ {
+ "description": "the userdata override policy with the userdata provided while deploying VM",
+ "name": "userdatapolicy",
+ "type": "string"
+ },
+ {
+ "description": "the pool type of the virtual machine",
+ "name": "pooltype",
+ "type": "string"
+ },
+ {
+ "description": "the project id of the vm",
+ "name": "projectid",
+ "type": "string"
+ },
+ {
+ "description": "instance name of the user vm; this parameter is returned to the ROOT admin only",
+ "name": "instancename",
+ "type": "string"
+ },
+ {
+ "description": "the memory used by the VM in KiB",
+ "name": "memorykbs",
+ "type": "long"
+ }
+ ],
+ "since": "3.0.0"
+ },
+ {
+ "description": "Delete one or more events.",
+ "isasync": false,
+ "name": "deleteEvents",
+ "params": [
+ {
+ "description": "the IDs of the events",
+ "length": 255,
+ "name": "ids",
+ "related": "listEvents",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
+ "length": 255,
+ "name": "enddate",
+ "required": false,
+ "type": "date"
+ },
+ {
+ "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")",
+ "length": 255,
+ "name": "startdate",
+ "required": false,
+ "type": "date"
+ },
+ {
+ "description": "delete by event type",
+ "length": 255,
+ "name": "type",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "response": [
+ {
+ "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"
+ },
+ {},
+ {}
+ ]
+ },
+ {
+ "description": " delete a nicira nvp device",
+ "isasync": true,
+ "name": "deleteNiciraNvpDevice",
+ "params": [
+ {
+ "description": "Nicira device ID",
+ "length": 255,
+ "name": "nvpdeviceid",
+ "related": "addNiciraNvpDevice,listNiciraNvpDevices",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "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": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {}
+ ]
+ },
+ {
+ "description": "List ucs blades",
+ "isasync": false,
+ "name": "listUcsBlades",
+ "params": [
+ {
+ "description": "",
+ "length": 255,
+ "name": "pagesize",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "",
+ "length": 255,
+ "name": "page",
+ "required": false,
+ "type": "integer"
+ },
+ {
+ "description": "List by keyword",
+ "length": 255,
+ "name": "keyword",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "ucs manager id",
+ "length": 255,
+ "name": "ucsmanagerid",
+ "related": "listUcsManagers,addUcsManager",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "associateUcsProfileToBlade",
+ "response": [
+ {
+ "description": "ucs blade dn",
+ "name": "bladedn",
+ "type": "string"
+ },
+ {
+ "description": "cloudstack host id this blade associates to",
+ "name": "hostid",
+ "type": "string"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "ucs manager id",
+ "name": "ucsmanagerid",
+ "type": "string"
+ },
+ {
+ "description": "associated ucs profile dn",
+ "name": "profiledn",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "ucs blade id",
+ "name": "id",
+ "type": "string"
+ },
+ {}
+ ]
+ },
+ {
+ "description": "Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user",
+ "isasync": true,
+ "name": "notifyBaremetalProvisionDone",
+ "params": [
+ {
+ "description": "mac of the nic used for provision",
+ "length": 255,
+ "name": "mac",
+ "required": true,
+ "type": "object"
+ }
+ ],
+ "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": "Get Volume Snapshot Details",
+ "isasync": false,
+ "name": "getVolumeSnapshotDetails",
+ "params": [
+ {
+ "description": "CloudStack Snapshot UUID",
+ "length": 255,
+ "name": "snapshotid",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "related": "getVolumeiScsiName",
+ "response": [
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "Volume iSCSI Name",
+ "name": "volumeiScsiName",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ }
+ ]
+ },
+ {
+ "description": "Deletes an ISO file.",
+ "isasync": true,
+ "name": "deleteIso",
+ "params": [
+ {
+ "description": "the ID of the ISO file",
+ "length": 255,
+ "name": "id",
+ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate",
+ "required": true,
+ "type": "uuid"
+ },
+ {
+ "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones",
+ "length": 255,
+ "name": "zoneid",
+ "related": "createZone,updateZone,listZones,listZones",
+ "required": false,
+ "type": "uuid"
+ }
+ ],
+ "response": [
+ {},
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {},
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "any text associated with the success or failure",
+ "name": "displaytext",
+ "type": "string"
+ },
+ {
+ "description": "true if operation is executed successfully",
+ "name": "success",
+ "type": "boolean"
+ }
+ ]
+ },
+ {
+ "description": "Updates a host.",
+ "isasync": false,
+ "name": "updateHost",
+ "params": [
+ {
+ "description": "Add an annotation to this host",
+ "length": 255,
+ "name": "annotation",
+ "required": false,
+ "since": "4.11",
+ "type": "string"
+ },
+ {
+ "description": "list of tags to be added to the host",
+ "length": 255,
+ "name": "hosttags",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable",
+ "length": 255,
+ "name": "allocationstate",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "the new uri for the secondary storage: nfs://host/path",
+ "length": 255,
+ "name": "url",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "description": "Whether the informed tag is a JS interpretable rule or not.",
+ "length": 255,
+ "name": "istagarule",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "description": "the id of Os category to update the host with",
+ "length": 255,
+ "name": "oscategoryid",
+ "related": "listOsCategories",
+ "required": false,
+ "type": "uuid"
+ },
+ {
+ "description": "Change the name of host",
+ "length": 255,
+ "name": "name",
+ "required": false,
+ "since": "4.15",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host to update",
+ "length": 255,
+ "name": "id",
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost",
+ "required": true,
+ "type": "uuid"
+ }
+ ],
+ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost",
+ "response": [
+ {
+ "description": "the name of the host",
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "description": "events available for the host",
+ "name": "events",
+ "type": "string"
+ },
+ {
+ "description": "the current status of the latest async job acting on this object",
+ "name": "jobstatus",
+ "type": "integer"
+ },
+ {
+ "description": "the outgoing network traffic on the host",
+ "name": "networkkbswrite",
+ "type": "long"
+ },
+ {
+ "description": "the UUID of the latest async job acting on this object",
+ "name": "jobid",
+ "type": "string"
+ },
+ {
+ "description": "true if the entity/resource has annotations",
+ "name": "hasannotations",
+ "type": "boolean"
+ },
+ {
+ "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning",
+ "name": "memorytotal",
+ "type": "long"
+ },
+ {
+ "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise",
+ "name": "suitableformigration",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in MHz",
+ "name": "cpuallocatedvalue",
+ "type": "long"
+ },
+ {
+ "description": "the date and time the host was last pinged",
+ "name": "lastpinged",
+ "type": "date"
+ },
+ {
+ "description": "the total disk size of the host",
+ "name": "disksizetotal",
+ "type": "long"
+ },
+ {
+ "description": "the cpu average load on the host",
+ "name": "cpuloadaverage",
+ "type": "double"
+ },
+ {
+ "description": "the admin that annotated this host",
+ "name": "username",
+ "type": "string"
+ },
+ {
+ "description": "the state of the host",
+ "name": "state",
+ "type": "status"
+ },
+ {
+ "description": "the OS category name of the host",
+ "name": "oscategoryname",
+ "type": "string"
+ },
+ {
+ "description": "the incoming network traffic on the host",
+ "name": "networkkbsread",
+ "type": "long"
+ },
+ {
+ "description": "the resource state of the host",
+ "name": "resourcestate",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently used",
+ "name": "memoryused",
+ "type": "long"
+ },
+ {
+ "description": "the host's currently allocated disk size",
+ "name": "disksizeallocated",
+ "type": "long"
+ },
+ {
+ "description": "the host out-of-band management information",
+ "name": "outofbandmanagement",
+ "type": "outofbandmanagementresponse"
+ },
+ {
+ "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise",
+ "name": "hahost",
+ "type": "boolean"
+ },
+ {
+ "description": "the host HA information information",
+ "name": "hostha",
+ "type": "hostharesponse"
+ },
+ {
+ "description": "the CPU speed of the host",
+ "name": "cpuspeed",
+ "type": "long"
+ },
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroup",
+ "response": [
+ {
+ "description": "the list of enabled vGPUs",
+ "name": "vgpu",
+ "response": [
+ {
+ "description": "Maximum Y resolution per display",
+ "name": "maxresolutiony",
+ "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": "Video RAM for this vGPU type",
+ "name": "videoram",
+ "type": "long"
+ },
+ {
+ "description": "Maximum displays per user",
+ "name": "maxheads",
+ "type": "long"
+ },
+ {
+ "description": "Model Name of vGPU",
+ "name": "vgputype",
+ "type": "string"
+ },
+ {
+ "description": "Maximum X resolution per display",
+ "name": "maxresolutionx",
+ "type": "long"
+ },
+ {
+ "description": "Maximum no. of vgpu per gpu card (pgpu)",
+ "name": "maxvgpuperpgpu",
+ "type": "long"
+ },
+ {
+ "description": "Maximum vgpu can be created with this vgpu type on the given gpu group",
+ "name": "maxcapacity",
+ "type": "long"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "GPU cards present in the host",
+ "name": "gpugroupname",
+ "type": "string"
+ }
+ ],
+ "type": "list"
+ },
+ {
+ "description": "Host details in key/value pairs.",
+ "name": "details",
+ "type": "map"
+ },
+ {
+ "description": "comma-separated list of tags for the host",
+ "name": "hosttags",
+ "type": "string"
+ },
+ {
+ "description": "the Pod ID of the host",
+ "name": "podid",
+ "type": "string"
+ },
+ {
+ "description": "the date and time the host was removed",
+ "name": "removed",
+ "type": "date"
+ },
+ {
+ "description": "the Zone name of the host",
+ "name": "zonename",
+ "type": "string"
+ },
+ {
+ "description": "capabilities of the host",
+ "name": "capabilities",
+ "type": "string"
+ },
+ {
+ "description": "the host version",
+ "name": "version",
+ "type": "string"
+ },
+ {
+ "description": "the number of CPU sockets on the host",
+ "name": "cpusockets",
+ "type": "integer"
+ },
+ {
+ "description": "the last annotation set on this host by an admin",
+ "name": "annotation",
+ "type": "string"
+ },
+ {
+ "description": "the hypervisor version",
+ "name": "hypervisorversion",
+ "type": "string"
+ },
+ {
+ "description": "the host hypervisor",
+ "name": "hypervisor",
+ "type": "string"
+ },
+ {
+ "description": "the last time this host was annotated",
+ "name": "lastannotated",
+ "type": "date"
+ },
+ {
+ "description": "the cluster type of the cluster that host belongs to",
+ "name": "clustertype",
+ "type": "string"
+ },
+ {
+ "description": "the Zone ID of the host",
+ "name": "zoneid",
+ "type": "string"
+ },
+ {
+ "description": "the cluster ID of the host",
+ "name": "clusterid",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated in percentage",
+ "name": "cpuallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated",
+ "name": "memoryallocated",
+ "type": "long"
+ },
+ {
+ "description": "true if the host is disconnected. False otherwise.",
+ "name": "disconnected",
+ "type": "date"
+ },
+ {
+ "description": "the CPU number of the host",
+ "name": "cpunumber",
+ "type": "integer"
+ },
+ {
+ "description": "true if the host has capability to support UEFI boot",
+ "name": "ueficapability",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "true if local storage is active, false otherwise",
+ "name": "islocalstorageactive",
+ "type": "boolean"
+ },
+ {
+ "description": "the date and time the host was created",
+ "name": "created",
+ "type": "date"
+ },
+ {
+ "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise",
+ "name": "hasenoughcapacity",
+ "type": "boolean"
+ },
+ {},
+ {
+ "description": "the cluster name of the host",
+ "name": "clustername",
+ "type": "string"
+ },
+ {
+ "description": "true if the host supports encryption",
+ "name": "encryptionsupported",
+ "type": "boolean"
+ },
+ {
+ "description": "the OS category ID of the host",
+ "name": "oscategoryid",
+ "type": "string"
+ },
+ {
+ "description": "the Pod name of the host",
+ "name": "podname",
+ "type": "string"
+ },
+ {
+ "description": "the management server ID of the host",
+ "name": "managementserverid",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor",
+ "name": "cpuwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "Whether the informed tag is a JS interpretable rule or not.",
+ "name": "istagarule",
+ "type": "boolean"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in percentage",
+ "name": "memoryallocatedpercentage",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory currently allocated in bytes",
+ "name": "memoryallocatedbytes",
+ "type": "long"
+ },
+ {
+ "description": "the IP address of the host",
+ "name": "ipaddress",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor",
+ "name": "cpuallocatedwithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the ID of the host",
+ "name": "id",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently allocated",
+ "name": "cpuallocated",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's CPU currently used",
+ "name": "cpuused",
+ "type": "string"
+ },
+ {
+ "description": "the amount of the host's memory after applying the mem.overprovisioning.factor",
+ "name": "memorywithoverprovisioning",
+ "type": "string"
+ },
+ {
+ "description": "the host type",
+ "name": "type",
+ "type": "type"
+ }
+ ]
+ },
+ {
+ "description": "Creates a egress firewall rule for a given network ",
+ "isasync": true,
+ "name": "createEgressFirewallRule",
+ "params": [
+ {
+ "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).",
+ "length": 255,
+ "name": "destcidrlist",
+ "required": false,
+ "type": "list"
+ },
+ {
+ "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).",
... 131955 lines suppressed ...